delete_mr_note

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

The description explicitly states 'This is destructive and cannot be undone', which adds behavioral context beyond the readOnlyHint=false annotation. It also clarifies the dry_run default behavior.

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 two sentences, front-loads purpose, and includes essential behavioral info with 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 delete tool with no output schema, the description covers the key aspects: purpose, destructiveness, and dry_run behavior. It could mention required permissions, but it is largely 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 has 100% description coverage, so the description does not need to elaborate on parameters. The description adds value by emphasizing the dry_run default, but overall the schema does the heavy lifting.

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 deletes an existing MR note. The name 'delete_mr_note' and description together distinguish it from siblings like delete_epic_note and delete_issue_note.

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 highlights that it is destructive and cannot be undone, and that dry_run=true by default, providing clear usage guidance. It does not explicitly compare to alternatives but the context is sufficient.

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