Check PDF Generation Status

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

Annotations already indicate readOnlyHint=true and idempotentHint=true. The description adds value by stating the HTTP method (GET), the return format (JSON object), and the zone limitation. It also implies the operation is non-destructive. No contradictions with 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?

The description is concise with about 5 sentences, front-loading the purpose, then adding a zone note, usage, return information, required parameters, and API endpoint. Each sentence is necessary and contributes to understanding. No redundant or vague phrasing.

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 explains the return value but is vague (file contents or download URL). It does not mention the pagination parameters or the response structure beyond being a JSON object. Since there is no output schema, the description should provide more detail about the response fields and pagination behavior.

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 provides full descriptions for all 5 parameters (100% coverage). The description repeats the three required parameters without adding new meaning, and it omits the pagination parameters (page, per_page). Therefore, the description adds no significant value 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 clearly states the tool checks the status of PDF generation for a prime contract change order batch, specifying the resource and action. It also mentions the return type. However, it does not explicitly differentiate among the many sibling check_pdf_generation_status tools with different API versions, which could cause confusion.

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 tells when to use the tool (to retrieve a file or URL for Prime Contracts) and lists required parameters. It also notes a zone restriction (US01, US02). However, it lacks guidance on when not to use it or alternatives among the multiple versioned siblings, such as check_pdf_generation_status_project_v2_0_4.

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