Filter and list documents by status, template, or update time. Use pagination to browse results.
List documents with optional filtering by status, template, or update time
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Page number for pagination (default: 1) | |
| status | No | Filter by document status | |
| template_id | No | Filter by template ID | |
| updated_since | No | Filter by update timestamp (ISO 8601 format) |
Changes observed during successful MCP inspections.
v1.0.0Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
With no annotations, the description carries the behavioral disclosure burden. The verb 'list' clearly signals a read-only operation, and the filtering scope is stated. However, it does not disclose behaviors like default pagination, ordering, or whether all documents are returned when no filters are provided.
Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.
Is the description appropriately sized, front-loaded, and free of redundancy?
A single sentence that states the action, resource, and filter options with no unnecessary words. The core function is front-loaded and every word earns its place.
Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.
Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?
The description and schema together are adequate for a simple, read-only listing operation with four optional parameters. However, there is no output schema and no mention of default behavior or alternatives, so some context is missing for an agent to make fully informed decisions.
Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.
Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?
Schema description coverage is 100%, so the input schema already documents all four parameters clearly. The description adds a concise summary of the filter options but no new semantic detail beyond the schema.
Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.
Does the description clearly state what the tool does and how it differs from similar tools?
The description states a specific verb and resource ('List documents') and names the exact filtering dimensions (status, template, update time). This distinguishes it from sibling tools like list_templates and list_snippets, which operate on different resources.
Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.
Does the description explain when to use this tool, when not to, or what alternatives exist?
The description implies the tool is for retrieving documents with optional filters, but it does not explicitly say when to use this over alternatives. No exclusions or conditions are provided, leaving the agent to infer usage.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.