Check PDF Generation Status

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

Annotations already declare readOnlyHint=true and idempotentHint=true. The description adds behavioral context: returns JSON with file contents or download URL, and zone support limitations. This goes beyond basic safety profile, though it lacks details on status values or pagination behavior.

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 mostly concise but includes some redundancy (e.g., 'Commitments' repeated) and the full endpoint path. It is front-loaded with the purpose and provides structured information, but could be trimmed slightly.

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?

While the description covers purpose, zone restriction, and return type, it lacks guidance on selecting this version among siblings (e.g., v2.0 vs v2.0_5). No output schema exists, but description partially compensates by stating return format. Pagination parameters are not explained in the description.

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 coverage is 100% with all parameters described. The description mentions required parameters but does not add additional meaning or context beyond what the schema provides. Baseline score of 3 is appropriate.

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 Commitment Change Order, using specific verbs and resource. It distinguishes the resource type (Commitment Change Order) and action (check status), providing a clear purpose.

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 includes a zone restriction (US01 and US02) and states it retrieves downloadable file or export URL, implying when to use. However, it does not explicitly differentiate from sibling tools with different versions or provide when-not-to-use guidance.

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