Delete GitHub Milestone

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

Annotations already declare destructiveHint=true and idempotentHint=false, so the safety profile is covered. The description still adds real value annotations cannot express: deletions are permanent and assigned issues are un-assigned rather than deleted — the key downstream side effect. It stops short of stating auth requirements or what the response reports.

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, front-loaded with the permanence warning and followed by the collateral-effect disclosure. Nothing is wasted or repeated from the schema.

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?

An output schema exists, so return values need not be described, and the irreversible side effects are covered. The remaining gap is that nothing warns the agent about the confirm:true requirement or the openWorld auth context, which matters for a destructive cross-system operation.

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 80%, with repo/owner/milestone_number/confirm all documented in the schema itself. The description adds no parameter-level detail (e.g. what milestone_number refers to or why confirm exists), and use_test_db plus the confirm const constraint are undocumented — baseline 3 is appropriate.

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?

States a specific verb and resource ('Permanently delete a GitHub milestone'), which cleanly separates it from the sibling create_github_milestone, update_github_milestone, get_github_milestone and get_github_milestones.

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 destructive intent is implied by 'Permanently delete', but the description never says when to prefer this over update_github_milestone or to verify existence via get_github_milestone first. No explicit when-not or prerequisite guidance beyond what the tool name conveys.

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