Update GitHub Milestone

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

Annotations already declare the safety profile (readOnlyHint=false, destructiveHint=false, idempotentHint=false), so the description's main added value is the state-transition semantics of "closed". It does not clarify merge/edit side effects, whether omitted fields are preserved, or what happens on an already-closed milestone.

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 sentences, no filler, and the highest-value instruction (how to close) is front-loaded after the purpose statement.

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?

With an output schema present and annotations covering safety, the description only needs to convey scope and mutation semantics, which it does. Minor gaps—auto-detected owner/repo and the practical need for a milestone identifier—are already handled by the schema's own parameter descriptions.

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 88%, so the schema already documents every parameter including the "closed" state value and YYYY-MM-DD due date. The description's field list mirrors the schema rather than adding syntax, format, or edge-case detail, so the baseline 3 applies.

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 uses a specific verb and resource ('Update a GitHub milestone') and enumerates the mutable fields (title, description, due date, state). The verb distinguishes it from get_/create_/delete_github_milestone siblings, though it never names them explicitly.

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?

It gives one actionable usage rule — set state to "closed" to close a completed milestone — which is genuinely helpful. It does not say when to prefer this over delete_github_milestone or create_github_milestone, nor does it mention prerequisites such as needing a milestone number.

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