update_iteration

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

The description adds the dry_run default and path detail, but does not disclose other behavioral traits (e.g., what happens on success, permissions needed). Annotations only indicate readOnlyHint=false, so the description carries some burden but could be more thorough.

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 are highly concise and front-loaded. The first sentence states the purpose, the second adds critical details without redundancy.

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?

Given no output schema and schema richness, the description provides sufficient context for usage. However, it does not describe the return value on success, which could help the agent.

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 description coverage is 100%, so baseline is 3. The description adds marginal value by noting iteration_iid is visible in list_iterations output, but does not explain parameter formats or constraints 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 verb 'Update' and the resource 'iteration' with an alias 'sprint'. It distinguishes from sibling tools like create_iteration and list_iterations.

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 provides context by specifying the REST path uses iteration_iid (per-group) and dry_run=true by default, implying safe usage. However, it does not explicitly state when to use this tool versus alternatives or when not to use it.

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