Delete Shortcut Milestone

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

With no annotations, the description carries the transparency burden. It clearly discloses that deletion is IRREVERSIBLE and requires explicit confirmation, which are important behavioral traits. It does not mention potential cascading effects or return values, but the irreversibility warning is significant.

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, focused sentence that front-loads the action and immediately follows with the most important requirements. No unnecessary 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?

The description covers the essential delete action and confirmation requirements, but omits the dry_run parameter behavior and any post-deletion effects or return value. Since there is no output schema, the description could be more 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 description repeats the confirmation requirements already documented in the schema (confirm and confirm_delete), adding no new meaning. It does not address the dry_run or milestone_id parameters, which have no schema descriptions. With 50% coverage, the description should compensate for the undocumented parameters, but it 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 permanently deletes a Shortcut milestone, using a specific verb and resource. It distinguishes itself from sibling tools like create_milestone, update_milestone, and list_milestones.

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 mentions the required parameters confirm_delete=true and confirm='CONFIRM_WRITE', giving clear execution prerequisites. It does not compare with alternatives, but the context is strong enough for correct usage.

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