Skip to main content
Glama
pvliesdonk
by pvliesdonk

list_documents

Read-onlyIdempotent

List documents from Paperless with filters such as tags, correspondent, and document type; include OCR content optionally.

Instructions

List documents with optional filters. Returns one page.

By default, per-document OCR content is stripped to keep results small. Pass include_content=True for the full text on each hit.

notes[].note and custom_fields[].value are always stripped from listings regardless of include_content — the metadata refs (note ids, timestamps, custom-field ids) are retained so callers can detect presence, but to read the actual text use get_document (with include_content=True if needed) or get_document_notes.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNo
tagsNo
orderingNo
page_sizeNo
custom_fieldNo
storage_pathNo
correspondentNo
document_typeNo
include_contentNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
nextNo
countYes
resultsNo
previousNo
Behavior5/5

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

The description adds significant behavioral context beyond annotations: it discloses that per-document OCR content is stripped by default, and that notes and custom_fields values are always stripped. This is crucial for understanding what results contain, and annotations only provide readOnlyHint, openWorldHint, etc.

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?

The description is concise (three paragraphs) and well-structured: first sentence states purpose, second explains default stripping, third clarifies immutable stripping. Every sentence adds value without redundancy.

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?

Given 9 parameters with 0% schema description and an output schema, the description explains critical quirks (stripping behavior) but does not explain the effect of filters or the pagination beyond 'returns one page'. The output schema exists, so return structure is covered, but overall completeness is average.

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

Parameters2/5

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

Schema coverage is 0%, so description must compensate. It only explains include_content in detail and mentions stripping behavior for notes and custom_fields. Other parameters (tags, ordering, custom_field, storage_path, correspondent, document_type, page, page_size) are not described at all. This is insufficient for a tool with 9 parameters.

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?

The description clearly states 'List documents with optional filters. Returns one page.' It specifies the action (list), resource (documents), and distinguishes from siblings like get_document (single document) and search_documents (likely full-text search).

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

Usage Guidelines4/5

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

The description provides guidance on when to use include_content and notes that for full text of notes and custom fields, callers should use get_document or get_document_notes. It gives clear context for stripping behavior, but does not explicitly compare to search_documents or other listing tools, leaving some ambiguity.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/pvliesdonk/paperless-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server