edit_milestone

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

There are no annotations, so the description carries the full behavioral burden. It usefully adds the 'YYYY-MM-DD' deadline format and the partial-update implication of 'and/or', but it does not disclose effects on unspecified fields, null-clearing behavior, required permissions, or the response shape after a successful edit.

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 a single compact sentence with no filler. The date-format constraint is placed at the point where deadline is mentioned, making the most behaviorally relevant detail easy to notice.

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 mutation tool with no output schema and no annotations, the essential fields and value format are present, but the description does not cover important operational context such as whether omitted fields remain unchanged or how to clear a field by passing null. It is adequate but not complete.

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?

The input schema gives no descriptions for individual properties, so the description must add meaning. It maps title, description, and deadline to the relevant properties and specifies the deadline format, but it leaves owner, repo, and milestone_id as implicit identifiers rather than explaining them.

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 starts with a specific verb ('Edit'), names the resource ('a milestone'), and enumerates exactly what can be changed: title, description, and deadline. This cleanly separates edit_milestone from sibling operations like create_milestone, close_milestone, reopen_milestone, and delete_milestone.

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 implies that the tool is used when an existing milestone's fields need to be modified, but it never explicitly states when not to use it or which sibling to prefer. An agent must infer the selection from the tool name and sibling list rather than from guidance.

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