list_documents

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

No annotations are provided, so the description carries the full burden of behavioral disclosure. It explains how filters, fields, order_by, limit, and limit_start affect the query and notes defaults. It does not mention authentication, rate limits, or error behavior, but these are generally less critical for a read-only list tool.

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?

The description is concise and well-structured, with a clear one-sentence purpose followed by a bulleted list of parameter explanations. Every sentence and example adds value without redundancy.

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 tool has an output schema, so return values are covered externally. The description addresses all six parameters and includes defaults and examples, making it functionally complete. It lacks explicit mention of read-only behavior or when to choose this over sibling list-type tools, but those are secondary gaps.

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?

The input schema has 0% description coverage, so the description is the only source of parameter meaning. It provides detailed syntax examples for filters, field selection, ordering, and pagination offsets, adding substantial meaning beyond the raw 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 'List/search documents of a DocType' clearly specifies the action (list/search) and resource (documents of a DocType). It implicitly distinguishes itself from sibling tools like get_document (which retrieves a single document) and create/update/delete (which are mutations).

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 usage for listing or searching multiple documents, but it does not explicitly state when to use this tool over alternatives such as get_count, get_document, or run_report. There is no direct comparison or exclusion of other tool usage scenarios.

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