Github Set Issue Milestone

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

The description states the mutation explicitly ('files', 'takes it off', 'clears the milestone') and adds the implementation detail that the tool looks up the title rather than taking GitHub's numeric ID. Annotations already mark readOnlyHint=false including idempotentHint=true, and the description is consistent with those.

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?

Three concise sentences with no filler. The core behavior is front-loaded, the distinguishing lookup behavior comes second, and the clearing instruction closes it out. Every sentence adds necessary information.

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?

For a simple four-parameter mutation with an output schema and annotations covering idempotence and destructive intent, the description covers the key behavioral and semantic needs. It does not describe what happens if the milestone title is not found, but the output schema and sibling tools fill most remaining 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 only 25%, so the description must compensate. It does explain that the milestone parameter is a title and that omitting it clears the milestone, which is critical. However, repo_owner, repo_name, and issue_number rely entirely on their names, which are fairly self-explanatory but not elaborated.

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 opens with a specific action and resource: 'Files an issue under a milestone, or takes it off one.' It also explicitly distinguishes this tool from github_update_issue by explaining the title-lookup behavior, so an agent can tell them apart immediately.

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 clearly explains the key usage nuance: pass a milestone title to set it, omit it to clear the milestone. It also references github_update_issue as the tool this lookup work is kept out of, giving useful context, though it doesn't fully spell out the exact conditions for choosing one over the other.

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