list-documents
List documents for a company with pagination. Returns Core document IDs.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Company ID | |
| page | No | Page number (default 1) | |
| perPage | No | Items per page (default 20, max 100) |
List documents for a company with pagination. Returns Core document IDs.
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Company ID | |
| page | No | Page number (default 1) | |
| perPage | No | Items per page (default 20, max 100) |
Changes observed during successful MCP inspections.
Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?
Annotations already declare readOnlyHint=true, destructiveHint=false, and openWorldHint=false, so the safety profile is covered. The description adds a meaningful behavioral fact beyond the annotations: the payload is "Core document IDs" only, which tells the agent a follow-up call (e.g., get-document) is needed for details. It omits ordering, total counts, and pagination limits, keeping it short of a 5.
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?
Two short sentences, front-loaded with the verb and resource, and the return-content note follows immediately. Nothing is wasted and no filler is present.
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?
For a simple, read-only list tool with full schema coverage, the description covers purpose, scope, pagination, and the shape of the return (IDs). The lack of an output schema is compensated by the note about Core document IDs, though ordering and empty-result behavior remain unstated.
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%, with all three parameters (id, page, perPage) self-documented including defaults and max. The description's "with pagination" merely restates what the schema already specifies and adds no syntax or format detail, so the baseline 3 applies.
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 gives a specific verb and resource ("List documents") plus a scope qualifier ("for a company") and notes pagination. It is distinguishable from get-document (single retrieval) and list-invoices, though it never explicitly contrasts itself with those siblings.
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?
It states what the tool does but offers no when-to-use guidance, no prerequisites, and no mention of alternatives such as get-document for full document details. Usage is only implied by the name and description.
Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.
Add one secure layer between your agents and this server.