Skip to main content
Glama

get_document

Read-only

Retrieves metadata and a Paperless link for a document by ID, enabling MCP clients to identify and open archived files.

Instructions

Get document metadata and a link to open it in Paperless. Use the list tools to look up names.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "document_id": "<document_id>"
    },
    "name": "get_document"
  }
}

Input Schema

NameRequiredDescriptionDefault
document_idYes

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true, so the safety profile is covered. The description adds genuinely useful scope detail that the result is metadata plus a URL rather than document contents, but says nothing about behavior on a nonexistent or 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.

Conciseness4/5

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

Two short sentences with no filler, and the primary purpose is front-loaded. The trailing lookup hint is slightly ambiguous about whether "names" means the document_id or human-readable labels.

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

Completeness3/5

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

An output schema exists, so return values need no explanation, and a single required parameter keeps the call surface small. What is missing is the relationship to sibling read/search tools, which matters for an agent deciding between fetching metadata and fetching content.

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 description coverage is 0%, so the schema supplies only a name, type, and exclusiveMinimum constraint for document_id. The description partially compensates by indicating that identifiers come from the list tools, but adds no format or range guidance beyond that.

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

Purpose4/5

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

"Get document metadata and a link to open it in Paperless" names a specific verb and resource, and the metadata-plus-link scope implicitly separates it from read_document's content retrieval. It never names that sibling explicitly, so an agent must infer the boundary.

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

Usage Guidelines3/5

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

The second sentence gives indirect guidance by pointing to the list tools as the source of identifiers, which is a useful call pattern. However, it never states when to choose this over read_document or search_documents, nor any precondition such as the document existing.

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