deals_update_installment

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

With no annotations, the description carries full burden. It only states 'Update an existing installment' implying mutation, but does not disclose permissions, rate limits, error behavior, or side effects. Minimal transparency beyond the basic action.

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, both essential. First sentence states the purpose, second provides parameter guidance. No wasted words.

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 covers purpose and parameter usage well, but lacks information about return value (no output schema) and error handling. For an update tool, typical return behavior is not mentioned, leaving some ambiguity.

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%, so the description does not need to duplicate schema info. However, it adds value by summarizing the updatable fields ('description / amount / billing_date') and clarifying that 'id' is the deal ID, which aids interpretation.

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?

Clearly states the action ('Update') and the resource ('an existing installment on a deal'). The description explicitly mentions 'API v2', distinguishing it from related tools like deals_add_installment and deals_delete_installment.

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 guidance on what parameters to provide ('deal id, installment_id, and any of description / amount / billing_date'). However, it does not explicitly state when to use this tool over alternatives (e.g., deals_add_installment) or any prerequisites.

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