Skip to main content
Glama
chrisguidry

paperless-mcp

by chrisguidry

Get document

get_document
Read-only

Retrieve a document's full metadata, notes, and custom fields by ID; optionally include full text when MCP resources are unavailable.

Instructions

Get a single document's full metadata, with its notes and custom fields.

The preferred way to read a document's text is its MCP resource at paperless://documents/{document_id}.

Input Schema

NameRequiredDescriptionDefault
document_idYesThe document's ID, from search_documents (required)
include_contentNoWhether to include the full text content. Pass true only if you cannot read MCP resources (default: false)

Output Schema

NameRequiredDescriptionDefault
idYes
uriYesMCP resource URI for the document's full text content
tagsYesTag IDs, resolvable with list_tags(ids=[...])
addedYesWhen the document entered the archive
notesNo
titleYes
contentNoFull text content, included only when requested
createdYesThe date on the document itself
web_urlNoLink to open this document in the Paperless web UI
modifiedYes
mime_typeNo
page_countNo
search_hitNoPresent only on results of a full-text query
storage_pathYesStorage path ID, resolvable with list_storage_paths(ids=[...])
correspondentYesCorrespondent ID, resolvable with list_correspondents(ids=[...])
custom_fieldsNo
document_typeYesDocument type ID, resolvable with list_document_types(ids=[...])
original_file_nameNo
archive_serial_numberNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.5/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already declare readOnlyHint=true and openWorldHint=false, so safety is covered. The description adds what the payload contains (metadata, notes, custom fields) and that text access is better served elsewhere, but says nothing about error behavior for a missing/inaccessible document ID.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Two short sentences, zero waste, with the primary action stated first and the alternative path second. Nothing to trim.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Output schema exists so return shape needs no explanation, and annotations carry the safety profile. The description still covers what is returned and how it relates to the resource path, leaving no actionable gap for calling it correctly.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema coverage is 100% and both parameters are documented, including the default and the 'only if you cannot read MCP resources' caveat for include_content. The description restates that resource preference rather than adding new parameter detail, so baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource with explicit scope: 'a single document's full metadata, with its notes and custom fields.' This clearly separates it from the search_/list_ siblings, which operate over collections rather than one document.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives explicit routing guidance: use the MCP resource at paperless://documents/{document_id} as the preferred way to read text, i.e. when-not to use this tool's content path. That is a genuine alternative with a selection condition, not just context.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.