jira_comment_edit

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

No annotations provided, so description fully bears the burden. Discloses mutation, required identification, parameter constraints, permission strictness, and return format. Missing idempotency note, but overall high transparency.

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?

Five sentences efficiently cover all key aspects: purpose, sibling contrast, body options, visibility, permissions, and return. No fluff, well-organized.

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 full schema coverage, no output schema, and no annotations, the description covers identification, body options, visibility, permissions, and return format. No critical 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%, but description adds value by explaining JFM markdown, mutual exclusivity of body/body_path, source of comment_id, and visibility usage. Enhances semantic understanding beyond 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 explicitly states 'Edit an existing JIRA comment' and identifies the unique identification method (key+comment_id). It contrasts with jira_comment for add/list, providing clear sibling differentiation.

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?

Explicit when-not and alternatives: 'To add a new comment or list comments use jira_comment instead.' Also clarifies parameter exclusivity (body vs body_path), visibility usage, and permission expectations with error handling.

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