Iterations: Update

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

Annotations show this is a mutation (readOnlyHint=false) and not destructive (destructiveHint=false). The description adds the key behavioral detail that only fields to update should be provided, implying PATCH semantics.

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, no fluff. Every word earns its place, front-loading the action and key behavior.

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?

Despite 8 parameters and no output schema, the description sufficiently explains the tool's behavior (partial update). It lacks return value info, but that's acceptable given no output schema.

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 schema already documents all parameters. The description doesn't add extra semantic meaning to parameters beyond the schema, but the baseline for full coverage is 3.

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?

Description clearly states 'Update an iteration' with a specific verb and resource. It distinguishes from sibling tools like iterations-create and iterations-delete by its update focus.

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 instruction 'Only provide fields to update' gives clear usage guidance indicating partial update behavior, though it doesn't explicitly contrast with other tools or specify prerequisites.

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