Add Change Order Package To A Requisition (Subcontractor Invoice)

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

Beyond annotations (readOnlyHint=false), the description only adds that it returns HTTP 201 on success and mentions adding items. It does not disclose side effects, authorization needs, or behavior when inputs are invalid. The misleading 'Creates a new Commitments' further reduces transparency.

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 moderately concise but includes redundant statements ('Creates a new Commitments' repeated) and extra endpoint info that could be omitted. It is front-loaded with purpose but could be tighter.

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 lacks return value details beyond 'returns the created object' and does not explain error conditions. With no output schema, more information about the response is expected. The contradictory commitment creation comment also undermines 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?

The input schema already has 100% coverage with descriptions. The description merely repeats the required parameter names without adding new semantic meaning or usage details.

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 adds a Change Order Package to a Requisition (Subcontractor Invoice), which will add change_order_items. However, it unnecessarily mentions 'Creates a new Commitments in Procore' which is contradictory to the tool's name and purpose, slightly reducing clarity.

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?

No guidance on when to use this tool versus alternatives like create_requisition_subcontractor_invoices_for_commitment or remove_change_order_package_from_a_requisition_subcontractor. The description only lists required parameters without context.

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