warp_get_documents

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

Description adds that auth is required and that BOLs are returned for external carriers, which annotations (readOnlyHint=true) do not cover. No contradictions; the read-only nature is consistent. Additional context beyond annotations.

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 sentences, no unnecessary words. First sentence states core purpose, second provides critical usage nuance. Efficient and well-structured.

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 read-only list tool with two parameters and no output schema, the description is reasonably complete: it covers what documents are listed, that URLs are returned, and gives special note about BOLs. Could mention that it's a filtered list, but overall adequate.

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?

Both parameters have schema descriptions, but the description adds practical insight: order_id is typically same as shipment_id, and document_type='bol' is required for external BOLs. This goes beyond the schema's basic descriptions.

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?

Description clearly states the action 'List shipment documents', specifies examples (BOL, POD, customs forms), and mentions return type (download URLs). Distinct from sibling tools like warp_track or warp_book.

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?

Provides explicit guidance on using document_type='bol' for external BOLs, and explains that omitting document_type lists all documents. Could be improved by mentioning when not to use this tool or alternatives, but current guidance is helpful.

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