delete_epic_note

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

Explicitly states destructive nature and irreversibility, adding value beyond the readOnlyHint=false annotation. The default dry_run behavior is also disclosed, providing key behavioral traits for safe invocation.

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?

Two sentences with no unnecessary words. The purpose is front-loaded, and critical behavior (destructive, dry_run) is immediately conveyed.

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?

Given the simplicity (2 params, no output schema), the description covers the essential context: what the tool does, its destructive nature, and default dry_run. No major gaps.

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 coverage is 100%, so the description adds little new meaning. It repeats the dry_run default from the schema. Adequate but not enhancing beyond structured data.

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?

Description clearly states 'Delete an existing epic note', providing a specific verb and resource. It differentiates from sibling tools like delete_issue_note by specifying 'epic note', but does not explicitly contrast them.

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?

Informs that the action is destructive and irreversible, and that dry_run=true by default, guiding the agent to use caution and confirm before setting dry_run=false. No explicit when-not or alternatives, but the context is clear.

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