jira_edit_comment

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

No annotations provided, so description carries full burden. States it edits a comment but does not detail behavior such as whether it replaces the entire content, required permissions, or side effects. Output schema exists but doesn't mitigate the lack of behavioral description.

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?

Well-structured with summary, argument list, and usage notes. Information is front-loaded. Could be slightly more concise, but all content is valuable and not repetitive.

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 tool complexity (3 params, no enums) and presence of output schema, the description covers purpose, parameters, and usage nuances adequately. Missing only behavioral details like permissions and idempotency.

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?

Input schema has 0% description coverage, but description compensates by explaining each parameter: issue_key, comment_id (source from jira_get_comments), comment (markdown content and formatting). Additionally provides detailed user mentioning syntax.

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?

Clearly states 'Edits an existing comment on a Jira issue.' Verb+resource. Distinguishes from sibling tools jira_add_comment and jira_delete_comment by specifying edit action.

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 guidance on mentioning users, including prerequisite call to jira_search_users and preference for @[accountId]. Lacks explicit when-not-to-use or alternative tool selection guidance, but the context is clear enough.

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