Show Commitment Change Order Batch

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

Annotations already indicate readOnlyHint=true and destructiveHint=false. The description adds little beyond stating it returns a JSON object. No contradiction, but no additional behavioral context.

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?

Description is concise and includes key elements: purpose, required parameters, and API endpoint. Minor typo ('Commitments' instead of 'Commitment') and inclusion of Procore API details slightly reduce conciseness.

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?

Covers basic purpose and required parameters, but lacks explanation of pagination parameters (page, per_page) and response structure. No output schema provided, so more detail on return format would improve completeness.

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?

Input schema has 100% description coverage for all 4 parameters. The description only reiterates required parameters (project_id, id) without adding new meaning 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 shows details of a Commitment Change Order Batch, with specific verb ('show') and resource. It distinguishes itself from siblings by naming the unique resource and providing the API endpoint.

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 clear context for when to use: 'fetch the full details of a specific Commitments by its identifier.' However, it does not explicitly mention when not to use this tool or compare with similar tools like 'show_all_commitment_change_order_batches'.

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