update_milestone

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

The description adds the key behavioral detail 'by default dry_run=true', which is not fully captured by the readOnlyHint annotation (false). This helps an agent understand the simulation nature. However, it does not disclose other behaviors like side effects or response format.

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 short, front-loaded sentences that efficiently convey purpose and key default behavior. No unnecessary 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?

Given the complexity (7 params, no output schema) and the presence of a closely related sibling (update_project_milestone), the description lacks guidance on when to choose this tool and what the output looks like. The dry_run info is helpful but incomplete for full context.

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 the schema already documents all parameters. The description's mention of dry_run default adds some value but largely repeats the schema. No additional parameter context beyond the schema is provided.

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 'update an existing milestone' (specific verb+resource). It distinguishes from create_milestone and close_milestone, but does not explicitly clarify that it is for group milestones versus project milestones, especially given the sibling tool update_project_milestone.

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 vs alternatives like update_project_milestone. The description does not mention prerequisites, when to confirm with user, or any constraints beyond the dry_run default.

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