Github Create Milestone

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

Annotations already indicate a non-read-only, non-idempotent, non-destructive mutation. The description adds meaningful behavioral detail beyond annotations: duplicate titles cause failure due to per-repository uniqueness, and existing milestones should be edited rather than recreated. It does not disclose further side effects, but the key failure mode is covered.

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 compact, front-loads the core behavior, and immediately follows with the most important constraint and alternative. Every sentence earns its place, including the pointer to the workflow skill.

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 and annotations cover the safety profile, so return values and mutation risks need less explanation. However, with six parameters and very low schema coverage, the description does not fully equip an agent to set state, due_on, or description correctly. The duplicate-title caveat and update alternative are useful, but parameter clarity remains a gap.

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 17%, so the description must compensate for undocumented parameters, but it does not explain repo_owner, repo_name, state, due_on, or description. It adds only that 'title' must be unique per repository. This is minimal value over the bare schema.

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 states the operation as 'Opens a milestone' and names the resource, and it distinguishes itself from github_update_milestone by explaining that duplicate titles fail and should be edited instead. However, 'opens' is less direct than 'creates', and the intended action relies partly on the tool title to disambiguate.

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 explicitly gives a when-not condition: duplicate titles fail because titles are unique per repository, and the agent is directed to github_update_milestone for that case. It also points to a workflow skill, github_get_skill('issue-management'), providing additional usage context. This is clear alternative guidance.

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