Github Set Issue Milestone

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

The description adds valuable behavioral detail beyond the annotations: it takes the title rather than the number and performs a lookup, and explains the clearing behavior via 'Omit the title to clear the milestone.' This does not contradict the annotations (readOnlyHint=false, idempotentHint=true) and enriches the agent's understanding of side effects.

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?

The description is two concise sentences plus a workflow reference, with the core purpose front-loaded. Every sentence adds information and there is no redundancy or fluff.

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?

It covers the primary action and the unique title-lookup behavior, and points to a skill for workflow. However, it leaves the required parameters unexplained and does not address error conditions or prerequisites like milestone existence. Given the tool's simplicity, this is a moderate gap but not severe.

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 only 25% (only milestone has a description). The description adds context that milestone is a title, but provides no elaboration on repo_owner, repo_name, or issue_number, which remain undocumented in both schema and description. With such low coverage, the description should compensate but does not.

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 tool's function: 'Files an issue under a milestone, or takes it off one.' It also distinguishes itself from the sibling github_update_issue by noting it handles the title lookup, making the purpose unambiguous and differentiated.

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 explicitly references github_update_issue as an alternative and clarifies that this tool handles the milestone work, implying when to use it. It also points to github_get_skill('issue-management') for workflow conventions, but it does not enumerate all alternatives or state explicit when-not-to-use conditions.

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