jira_comment_delete

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

Despite no annotations, the description fully discloses irreversibility, the confirm safeguard (refuses without API call if false), and the CLI mirror. It also states the return type (short status line), covering all key behavioral aspects.

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?

Extremely concise: three sentences each serving a distinct purpose (purpose, usage, alternative/behavior). No redundant or extraneous information.

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 simple tool (3 params, no output schema) and no annotations, the description covers all necessary aspects: purpose, identification, prerequisite, irreversibility, alternative, and return value. It is complete for this context.

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% with parameter descriptions. The description adds value beyond schema by explaining how to obtain comment_id and emphasizing the confirm requirement, but does not significantly extend parameter semantics.

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 verb (delete), resource (JIRA comment), and identification method (key + comment_id). It also distinguishes from the sibling tool jira_comment_edit by explicitly noting the alternative for editing.

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?

Provides explicit when-to-use guidance (delete a comment), how to obtain the comment_id (from jira_comment list), prerequisite (confirm: true), and a clear alternative (jira_comment_edit for editing).

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