Skip to main content
Glama
pvliesdonk
by pvliesdonk

List Documents

list_documents
Read-onlyIdempotent

Lists documents with optional filters for tags, correspondent, document type, storage path, or custom field. Returns one page of metadata, excluding OCR content and note values.

Instructions

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.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNo
tagsNo
orderingNo
page_sizeNo
custom_fieldNo
storage_pathNo
correspondentNo
document_typeNo

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
nextNo
countYes
resultsNo
previousNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.1.0
    • removedInput schema / properties / include_content
      Removed value: -{
      -  "default": false,
      -  "type": "boolean"
      -}
  2. First observedv1.0.1

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, and destructiveHint=false, covering safety. The description adds behavioral context about response content: OCR content is stripped, notes and custom fields values are stripped but metadata refs retained, and pagination returns one page. This goes beyond annotations and informs the agent about data truncation and how to retrieve full values.

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 three concise sentences, front-loaded with the core purpose and pagination, then detailing what is stripped and pointing to alternatives. There is no fluff or redundant information; every sentence adds value.

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?

The description covers the main behavior, pagination, and content truncation, and the output schema (not shown) likely defines the return structure. However, it lacks parameter-level guidance for the eight optional filters, which could be important for correct invocation. Given the annotations and output schema, the description is adequate but not fully comprehensive for a tool with many optional parameters.

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 description coverage is 0%, meaning the schema provides no parameter descriptions. The description only mentions 'optional filters' without explaining the meaning or usage of any of the eight parameters (e.g., tags, custom_field, storage_path). Parameter names are somewhat self-explanatory, but the description does not add semantic value to help the agent choose or format filter values.

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 the tool's function: 'List documents with optional filters. Returns one page.' It also distinguishes itself from related tools by noting what is stripped (OCR content, notes, custom fields) and pointing to alternatives like get_document_content, get_document, and get_document_notes. This makes the purpose unambiguous and differentiates it from siblings.

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 explicit guidance on when to use this tool versus alternatives: 'Use get_document_content for a bounded preview' and 'use get_document or get_document_notes to read those values.' It also implies pagination usage by stating 'Returns one page.' However, it does not directly contrast with search_documents or explain when a list vs. a search is appropriate, which is a minor gap.

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