tool catalog · generated from the server, version 0.1.0

Every tool, every parameter

39 tools are listed by default (read mode). --mode write adds 11 that change things on archive.org, and --allow-delete adds 2 more. This page is built from the server's own tool list, so it matches what an MCP client sees.

Write tools work in two calls: the first returns a preview and a confirmation_id; the same call again with that id makes the change. More on safety.

3 tools

analysis

Summaries worked out with DuckDB: Wayback histories, search and TV News counts (needs the analysis extra).
search_summaryCounts for a search by mediatype, collection, language, creator, year; downloads.read

Search summary · read-only

ParameterTypeBoundsDescription
query requiredtextmax length 2000e.g. 'collection:prelinger'.
include_downloadsyes/noAlso download and size stats (reads up to 10,000 items).
limitintegermin 1; max 25Per list.
tvnews_program_countsMatching TV News programs counted by day, week or month and channel.read

TV News program counts · read-only

ParameterTypeBoundsDescription
querytextmax length 500In titles, descriptions, topics; not captions.
channeltexte.g. CNNW.
from_datetext
to_datetext
intervalone of auto, day, week, month
limitintegermin 1; max 25Per list.
wayback_history_summaryA page's captures by year or month: statuses, errors and content versions.read

Wayback history summary · read-only

ParameterTypeBoundsDescription
url requiredtextmax length 2048http or https.
from_timestamptextEarliest, e.g. '2015'.
to_timestamptextLatest, e.g. '20201231'.
intervalone of auto, year, monthGroup by; auto: month under 3 years.
one_per_dayyes/noOne capture a day: reaches further.
detailone of summary, fullfull: statuses per period, every list.
limitintegermin 1; max 100Per list (full).
1 tool

changes

The Changes API: recently changed items.
recent_changesIdentifiers of recently changed items. Needs privileged keys.read

Recently changed items · read-only

ParameterTypeBoundsDescription
from_datetextChanges since this UTC day. Default: from now.
cursortextThe last next_cursor.
limitintegermin 1; max 5000
3 tools

iiif

IIIF manifests and image URLs for scanned items.
get_page_imageSee a book page, IIIF image, image file or thumbnail as an image.read

Look at a page or image · read-only

ParameterTypeBoundsDescription
identifiertextWith scan_page, file or thumbnail.
scan_pageintegermin 1; max 100000Page or image, from 1.
filetextmax length 500An image file, as get_item lists it.
image_idtextmax length 1000Or an image_id from iiif_manifest.
thumbnailyes/noSmall thumbnail instead.
max_sizeintegermin 100; max 2000Longest side, in pixels.
regiontextmax length 100Crop: full, square, x,y,w,h or pct:x,y,w,h.
formatone of jpg, png
iiif_image_urlA page's IIIF image URL at any size, region or rotation.read

IIIF image URL · read-only

ParameterTypeBoundsDescription
identifiertextWith scan_page, or use image_id.
scan_pageintegermin 1; max 100000Page or image, from 1.
image_idtextmax length 1000From iiif_manifest, instead.
regiontextmax length 100full, square, x,y,w,h or pct:x,y,w,h.
sizetextmax length 50max, 'w,', ',h', 'w,h', '!w,h' (fit inside) or pct:n.
rotationtextmax length 10Degrees, 0-360; '!' first mirrors.
qualityone of default, color, gray, bitonal
formatone of jpg, png, gif, tif
iiif_manifestAn item's pages or images: labels, sizes, image ids.read

IIIF manifest · read-only

ParameterTypeBoundsDescription
identifier requiredtext
offsetintegermin 0; max 100000
limitintegermin 1; max 200
include_metadatayes/noAlso metadata and download links.
28 tools

items

archive.org items: search, metadata, files, reviews, full text and downloads.
account_infoWhich archive.org account the keys belong to, and the server's mode.read

Account in use · read-only

No parameters.

download_filesDownload chosen files into --download-dir; skips files already there.read

Download files

ParameterTypeBoundsDescription
identifier requiredtext
fileslist of textmax items 200As get_item lists them.
formatslist of textmax items 50As get_item lists them.
globtextmax length 500Names, e.g. '*.mp3|*.txt'.
excludetextmax length 500Names to leave out.
get_full_textA book's OCR text in chunks, from a byte offset or a scan page.read

Read a book's OCR text · read-only

ParameterTypeBoundsDescription
identifier requiredtext
offsetintegermin 0In bytes: the last next_offset.
scan_pageintegermin 1Start at this scan page instead.
max_charsintegermin 1000; max 50000
filetextmax length 500A .txt file to read instead.
book_prefixtextFile prefix of one book in a multi-book item; default the first.
get_hocrOne scan page's OCR text and words, with pixel boxes and confidence.read

OCR words on a book page · read-only

ParameterTypeBoundsDescription
identifier requiredtext
scan_page requiredintegermin 1As in search_inside and page images.
words_limitintegermin 0; max 3000
book_prefixtextFile prefix of one book in a multi-book item; default the first.
get_itemAn item's metadata, files (name, format, size, md5) and links.read

Show an item · read-only

ParameterTypeBoundsDescription
identifier requiredtext
files_offsetintegermin 0
files_limitintegermin 0; max 5000: none.
file_sourceone of all, original, derivative, metadata
max_field_charsintegermin 100; max 20000Cut longer values.
get_reviewsAn item's reviews, newest first, and the average rating.read

Read an item's reviews · read-only

ParameterTypeBoundsDescription
identifier requiredtext
mineyes/noOnly your own review (needs keys).
offsetintegermin 0
limitintegermin 1; max 50
max_body_charsintegermin 100; max 10000Cut longer reviews.
get_simplelistsThe Simple Lists an item is in, or the members of its own lists.read

Show an item's simple lists · read-only

ParameterTypeBoundsDescription
identifier requiredtext
membersyes/noList the members of its own lists instead.
list_nametextWith members: only this list, e.g. 'holdings'.
limitintegermin 1; max 100
pageintegermin 1; max 1000
get_subtitlesAn item's subtitle files, or one read as timestamped text.read

Subtitles · read-only

ParameterTypeBoundsDescription
identifier requiredtext
filetextmax length 500To read; omit to list them.
startintegermin 0; max 864000Seconds in.
offsetintegermin 0The last next_offset.
max_charsintegermin 1000; max 50000
globtextmax length 500Names, e.g. '*.mp3|*.txt'.
get_tasksAn item's queued, running and finished tasks. Needs keys.read

List an item's tasks · read-only

ParameterTypeBoundsDescription
identifier requiredtext
whichone of all, active, historyactive (queued, running), history (finished) or all.
limitintegermin 1; max 100
cursortextmax length 500The last next_cursor.
list_collectionOne page of a collection's items, with the total.read

List a collection's items · read-only

ParameterTypeBoundsDescription
identifier requiredtext
mediatypetexte.g. 'texts'.
fieldslist of textmax items 50Default: identifier, title, mediatype, creator, date, downloads.
sortlist of textmax items 5Default: ['downloads desc'].
limitintegermin 1; max 100
pageintegermin 1; max 1000
my_itemsYour uploads, newest first: done or still processing. Needs keys.read

List your uploads · read-only

ParameterTypeBoundsDescription
pending_onlyyes/noOnly items still processing or failed.
limitintegermin 1; max 100
pageintegermin 1; max 1000
search_full_textTexts whose OCR text matches, with the matching passages.read

Full-text search · read-only

ParameterTypeBoundsDescription
query requiredtextmax length 1000Words or a "phrase"; Lucene syntax.
limitintegermin 1; max 50
pageintegermin 1; max 1000
search_insideFind a word or phrase in a scanned book: scan pages and context.read

Search inside a book · read-only

ParameterTypeBoundsDescription
identifier requiredtext
query requiredtextmax length 200
limitintegermin 1; max 100
book_prefixtextFile prefix of one book in a multi-book item; default the first.
search_itemsOne page of matching items, and the total.read

Search archive.org items · read-only

ParameterTypeBoundsDescription
query requiredtextmax length 2000e.g. 'title:(moby dick) AND mediatype:texts'.
fieldslist of textmax items 50Default: identifier, title, mediatype, creator, date, collection.
sortlist of textmax items 5e.g. ['downloads desc'].
limitintegermin 1; max 100
pageintegermin 1; max 1000
search_items_deepsearch_items for large result sets, paged by cursor.read

Page through big searches · read-only

ParameterTypeBoundsDescription
query requiredtextmax length 2000
fieldslist of textmax items 20
sortlist of textmax items 5Put 'identifier' last.
limitintegermin 100; max 500
cursortextmax length 2000The last next_cursor.
add_reviewPost your review of an item, replacing your earlier one.write

Review an item · destructive

ParameterTypeBoundsDescription
identifier requiredtext
title requiredtextmax length 255One line.
body requiredtextmax length 20000
starsintegermin 0; max 50 to 5; leave out for no rating.
confirmation_idtextmax length 64Omit to preview; then the preview's id.
copy_filesCopy chosen files into another item, or the same one.write

Copy files · destructive

ParameterTypeBoundsDescription
identifier requiredtext
to_identifier requiredtext
fileslist of textmax items 200As get_item lists them.
formatslist of textmax items 50As get_item lists them.
globtextmax length 500Names, e.g. '*.mp3|*.txt'.
excludetextmax length 500Names to leave out.
to_foldertextmax length 200A folder in the destination.
to_nametextmax length 512New name (one file only).
deriveyes/noDerive the destination afterwards.
confirmation_idtextmax length 64Omit to preview; then the preview's id.
flag_itemAdd or remove your flag on an item (for the Archive's staff).write

Flag an item · destructive

ParameterTypeBoundsDescription
identifier requiredtext
category requiredtext
actionone of add, remove
confirmation_idtextmax length 64Omit to preview; then the preview's id.
job_cancelStop a job; finished files stay.write

Cancel a job

ParameterTypeBoundsDescription
job_id requiredtextThe job_id a write tool returned.
job_statusProgress and results of a background job, or a list of your jobs.write

Show a job · read-only

ParameterTypeBoundsDescription
job_idtextOmit to list your jobs.
wait_secondsintegermin 0; max 300Wait for the job to end, sending progress.
modify_metadataSet, append or remove metadata of an item or its files; previews a diff first.write

Change metadata · destructive

ParameterTypeBoundsDescription
identifier requiredtext
set_fieldsobjectField to value(s), e.g. {'subject': ['maps']}.
append_valuesobject
remove_valuesobject
remove_fieldslist of textmax items 50Fields to remove entirely.
fileslist of textmax items 50Change these files' metadata instead of the item's.
confirmation_idtextmax length 64Omit to preview; then the preview's id.
move_filesMove chosen files to another item, or rename them within one.write

Move files · destructive

ParameterTypeBoundsDescription
identifier requiredtext
to_identifier requiredtext
fileslist of textmax items 200As get_item lists them.
formatslist of textmax items 50As get_item lists them.
globtextmax length 500Names, e.g. '*.mp3|*.txt'.
excludetextmax length 500Names to leave out.
to_foldertextmax length 200A folder in the destination.
to_nametextmax length 512New name (one file only).
deriveyes/noDerive the destination afterwards.
confirmation_idtextmax length 64Omit to preview; then the preview's id.
submit_taskRerun derivation on an item you uploaded (e.g. after uploads).write

Rerun a derive · destructive

ParameterTypeBoundsDescription
identifier requiredtext
tasktextOnly 'derive' (remake OCR, PDFs, thumbnails).
remove_derivedtextmax length 200Glob of derived files to delete first, e.g. '*.pdf'.
confirmation_idtextmax length 64Omit to preview; then the preview's id.
update_simplelistAdd an item to a collection's simple list, or remove it.write

Change a simple list · destructive

ParameterTypeBoundsDescription
identifier requiredtext
parent requiredtextThe list's parent collection.
list_name requiredtextThe list, e.g. 'holdings'.
actionone of add, remove
notestextmax length 2000With add.
confirmation_idtextmax length 64Omit to preview; then the preview's id.
upload_filesCreate an item or add files to one, from --upload-root folders, as a job.write

Upload files · destructive

ParameterTypeBoundsDescription
identifier requiredtext
paths requiredlist of textmax items 100Files or folders in an --upload-root.
rights_confirmedyes/noTrue only if the user says they hold the rights.
titletextmax length 500A new item's title.
mediatypeone of texts, movies, audio, image, data, softwareA new item's mediatype.
collectiontextDefault: the mediatype's community one. test_collection: trials.
metadataobjectA new item's other fields (creator, date, ...).
to_foldertextmax length 200A folder in the item.
deriveyes/noDerive afterwards (OCR, previews).
confirmation_idtextmax length 64Omit to preview; then the preview's id.
delete_filesDelete chosen files (or all_files) of an item; the preview lists each one.delete

Delete files · destructive

ParameterTypeBoundsDescription
identifier requiredtext
fileslist of textmax items 200As get_item lists them.
formatslist of textmax items 50As get_item lists them.
globtextmax length 500Names, e.g. '*.mp3|*.txt'.
excludetextmax length 500Names to leave out.
all_filesyes/noEvery file of the item, instead of a choice.
include_derivativesyes/noAlso their derived files.
keep_old_versionsyes/noKeep copies in history/files.
confirmation_idtextmax length 64Omit to preview; then the preview's id.
delete_reviewDelete your own review of an item; the preview shows it first.delete

Delete your review · destructive

ParameterTypeBoundsDescription
identifier requiredtext
confirmation_idtextmax length 64Omit to preview; then the preview's id.
8 tools

openlibrary

Open Library: books, editions, authors, subjects, covers and scans.
book_availabilityCan a book be read or borrowed now (1-hour, 14-day loans)? With the borrow link.read

Book availability · read-only

ParameterTypeBoundsDescription
identifiertextmax length 100An archive.org book.
book_idtextmax length 300Or an Open Library edition or work ID, or ISBN.
openlibrary_authorAn author: names, dates, biography, photo, best-known works.read

Open Library author · read-only

ParameterTypeBoundsDescription
author requiredtextmax length 300Author ID like 'OL34184A', or its URL.
works_limitintegermin 0; max 50
openlibrary_cover_urlBuild a covers.openlibrary.org image URL (downloads nothing).read

Open Library cover URL · read-only

ParameterTypeBoundsDescription
by requiredone of id, olid, isbn, oclc, lccnWhat value is.
value requiredtextmax length 40
kindone of book, authorBook cover or author photo.
sizeone of S, M, L
openlibrary_editionOne edition: publisher, date, ISBNs, pages, contents, its scan.read

Open Library edition · read-only

ParameterTypeBoundsDescription
edition requiredtextmax length 300Edition ID like 'OL7353617M', an ISBN, or a URL.
openlibrary_scanThe archive.org scans of an edition or work, and whether each is public.read

Scans of a book · read-only

ParameterTypeBoundsDescription
book_id requiredtextmax length 300Edition ID, ISBN, or work ID (for scans of any edition).
limitintegermin 1; max 20
check_accessyes/noCheck each scan is public (a request each).
openlibrary_subjectWorks on a subject, place, person or time, with the total.read

Open Library subject · read-only

ParameterTypeBoundsDescription
subject requiredtextmax length 100e.g. 'whaling', or 'place:...', 'person:...', 'time:...'.
limitintegermin 1; max 50
offsetintegermin 0; max 10000
ebooks_onlyyes/noOnly works with a scan on archive.org.
openlibrary_workA work (a book across editions): authors, description, subjects, covers.read

Open Library work · read-only

ParameterTypeBoundsDescription
work requiredtextmax length 300Work ID like 'OL45804W', or its URL.
editions_limitintegermin 0; max 50
2 tools

tvnews

The TV News Archive: program search and closed captions.
tvnews_captionsUp to 5 minutes of a program's captions, with times and a clip link.read

TV News captions · read-only

ParameterTypeBoundsDescription
identifier requiredtextmax length 100From tvnews_search.
startintegermin 0; max 86400Seconds into the program.
durationintegermin 10; max 300Seconds to read.
aroundintegermin 0; max 86400Centre the window here instead (seconds in).
1 tool

views

View counts for items and collections.
item_viewsView counts (all time, last 30 and 7 days) for items or collections.read

Item view counts · read-only

ParameterTypeBoundsDescription
identifiers requiredlist of textmax items 50Items or collections (which count their items' views).
daysintegermin 0; max 90Also daily views for the last N days (at most 10 identifiers).
6 tools

wayback

The Wayback Machine: availability, CDX capture history, page text and diffs.
wayback_availableThe Wayback capture of a page closest to a time, if any.read

Closest Wayback capture · read-only

ParameterTypeBoundsDescription
url requiredtextmax length 2048http or https.
timestamptextClosest to this time. Default: the newest.
wayback_cdxA page's Wayback captures (CDX). Syntax: internet-archive://wayback/syntax.read

Wayback captures (CDX) · read-only

ParameterTypeBoundsDescription
url requiredtextmax length 2048Page address; with match_type, where to match from.
match_typeone of exact, prefix, host, domainprefix: pages under the path; domain: with subdomains.
from_timestamptextEarliest, e.g. '2015'.
to_timestamptextLatest, e.g. '20201231'.
filterslist of textmax items 5'field:regex', '!' first excludes, e.g. 'statuscode:200'.
collapselist of textmax items 3Skip rows repeating a field: 'digest' (content changes), 'timestamp:8' (daily).
fieldslist of one of urlkey, timestamp, original, mimetype, statuscode, digest, lengthmax items 7Columns. Default: all but urlkey.
limitintegermin 1; max 500
newestyes/noThe newest captures instead of the oldest (no cursor).
cursortextThe last next_cursor.
wayback_compareWhat changed between two captures of a page, as a diff of their text.read

Compare two Wayback captures · read-only

ParameterTypeBoundsDescription
url requiredtextmax length 2048http or https.
from_timestamp requiredtextThe earlier capture.
to_timestamptextThe later one. Default: the newest.
context_linesintegermin 0; max 10Unchanged lines around changes.
max_linesintegermin 10; max 2000
wayback_fetchA capture of a page as clean text, in chunks.read

Read a Wayback capture · read-only

ParameterTypeBoundsDescription
url requiredtextmax length 2048http or https.
timestamptextClosest to this time. Default: the newest.
offsetintegermin 0; max 1000000
max_charsintegermin 500; max 50000
include_titleyes/no
include_linksyes/noUp to 200.
wayback_save_statusThe status of a Save Page Now capture job. Needs keys.read

Save Page Now status · read-only

ParameterTypeBoundsDescription
job_id requiredtextThe job_id Save Page Now returned.
wayback_saveAsk the Wayback Machine to capture one page now.write

Save Page Now

ParameterTypeBoundsDescription
url requiredtextmax length 2048http or https.
capture_allyes/noCapture error pages (4xx/5xx) too.
capture_screenshotyes/noAdd a screenshot.
skip_first_archiveyes/noSkip the first-capture check (faster).
if_not_archived_withintextSkip if a capture is newer, e.g. '3d 5h' or '3600'.
delay_wb_availabilityyes/noPublish after ~12 hours (eases load).
confirmation_idtextmax length 64Omit to preview; then the preview's id.