List documents with optional filters. Returns one page.

Per-document OCR content is stripped to keep results small. Use get_document_content for a bounded preview of one result.

notes[].note and custom_fields[].value are always stripped from listings. The metadata refs (note ids, timestamps, custom-field ids) are retained so callers can detect presence; use get_document or get_document_notes to read those values.

Full-text search documents.

Per-hit OCR content is stripped. Use get_document_content for a bounded preview of one hit. Use more_like for similarity search.

notes[].note and custom_fields[].value are always stripped from search hits; fetch them via get_document or get_document_notes when needed.

Fetch one document by ID.

OCR content is stripped to keep responses small. Call get_document_content for a bounded preview, or use create_download_link with the content variant when available.

Return the OCR'd text content of a document.

Documents such as books and technical standards can run to millions of characters, so each call is capped at 20,000. A partial result opens with a marker naming the character range returned, the document's full length, and the offset to pass to read the next section; text that fits under the cap is returned whole with no marker.

Return the document's thumbnail as inline image content.

Return technical metadata for a document (checksums, filenames, etc.).

Return notes attached to a document.

Return the audit history for a document.

Return Paperless's classifier suggestions for a document.

Patch selected fields on a document.

The response strips OCR content. Use get_document_content or a transfer link when the updated text is needed.

Delete a document.

Upload a document. Returns the task UUID for polling via get_task.

Apply a bulk operation to a set of documents.

Paperless writes the change before answering OK, then queues the search-index rebuild as a background task. A following search_documents call can therefore miss the edited documents for seconds to minutes, while list_documents and get_document reflect the change at once. Metadata operations queue a bulk_update task: find it with list_tasks(task_type="bulk_update") and wait_for_task on its task_id to wait for full-text search to catch up.

Append a note to a document.

Remove a note from a document.

List tags.

Fetch a tag by ID.

Create a new tag.

Patch selected fields on a tag.

Delete a tag.

Apply a bulk operation to a set of tags.

List correspondents.

Each row's last_correspondence is the date of the correspondent's newest document, or null when it has none; ordering accepts it.

Fetch a correspondent by ID.

Create a new correspondent.

Patch selected fields on a correspondent.

Delete a correspondent.

Apply a bulk operation to a set of correspondents.

List document types.

Fetch a document type by ID.

Create a new document type.

Patch selected fields on a document type.

Delete a document type.

Apply a bulk operation to a set of document types.

List custom fields.

Fetch a custom field by ID.

Create a new custom field.

extra_data depends on data_type:

• string, longtext, integer, boolean, float, date, url, documentlink — unused; omit or pass null.

• monetary — optional {"default_currency": "USD"} (ISO-4217).

• select — extra_data required: {"select_options": [{"label": "Low"}, {"label": "Medium"}]}. Paperless assigns each option a stable id on creation.

Unknown shapes are rejected by Paperless with a 400.

Patch selected fields on a custom field definition.

extra_data shape depends on data_type:

• monetary — optional {"default_currency": "USD"} (ISO-4217).

• select — extra_data.select_options replaces the current list wholesale. To preserve existing values, include each existing option with its server-assigned id: {"select_options": [{"id": "abc", "label": "Low"}, ...]}. Omitting an option's id creates a new option; dropping an option from the list deletes it and any document values referencing it. A patch without extra_data, such as a rename, keeps the current options: the server reads them and sends them back with their ids.

See create_custom_field for the full extra_data shape table.

Delete a custom field.

List storage paths.

Fetch a storage path by ID.

List saved views.

Visibility flags are null when payload v10 omits those preferences.

Fetch a saved view by ID.

Visibility flags are null when payload v10 omits those preferences.

List share links (optionally filtered by document).

Fetch a share link by ID.

List Paperless Celery tasks.

Defaults to unacknowledged tasks only (set include_acknowledged=True or acknowledged=True to see acknowledged ones). Returns one page, newest first.

Pass task_type to filter by the kind of work — "bulk_update" is the search-index rebuild that bulk_edit_documents queues, so that tool's deferred indexing can be waited on with wait_for_task. Version 10 adds task_type, trigger_source, structured result_data, related_document_ids and timing fields. Statuses retain their uppercase spelling. Legacy task_name, type, result and related_document remain compatibility projections; use the v10 fields for full detail.

Fetch a task by UUID. Returns None if no such task exists.

Poll until the task reaches a terminal state or times out.

Fetch collection-level statistics.

Check whether a newer release of Paperless-NGX exists upstream.

Answers the newest release published on GitHub, and whether it is newer than the connected instance -- not the version installed on that instance. The two coincide only while the instance is up to date. Call get_server_info for the installed version.

Report wrapper and upstream version info for paperless-mcp. Returns server_name, server_version, core_version (fastmcp-pvl-core), and (when configured) an upstream version block. Useful for verifying a deployment matches the expected build.