create_milestone

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

No annotations are provided, so the description carries full burden. It discloses that new milestones start in state 'open' and returns the milestone with id. However, it does not mention authorization requirements, rate limits, or potential error conditions like duplicate titles or missing repo/owner.

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 sentences, each earning its place: first defines action, second lists parameters with required/optional/format, third provides initial state and return value. No wasted words.

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 creation tool with 5 parameters (1 required) and no output schema, the description covers purpose, parameter details, behavior (start state), and return value. It could mention error handling or cases like missing defaults, but overall sufficient given sibling tools exist.

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 100%, but the description adds value by reinforcing which parameters are required vs optional, providing an ISO 8601 example for due_on, and noting that milestones start in state 'open' (not a parameter). This goes beyond the 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 clearly states 'Create a milestone' with specific verb and resource. It distinguishes from siblings like update_milestone, delete_milestone, get_milestone, and list_milestones by focusing on creation behavior.

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 provides parameter usage details (required, optional, format) but does not explicitly say when to use this tool versus alternatives like update_milestone or when not to use it. No exclusions or context about prerequisites.

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