add_comment

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

Annotations are absent, so the description carries the full burden of behavioral disclosure. It only states the action without any side effects, permissions, or expectations about the operation. An agent cannot learn whether the comment appends to existing comments, whether it is reversible, or what the response looks like. This is a significant gap for a mutation tool.

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 a single, efficient sentence that communicates the core purpose without extra words. It is appropriately front-loaded and has no waste. However, it offers no additional structure or detail beyond the bare action, which keeps it from a 5.

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 mutation tool with no annotations and no output schema, the description is incomplete. It lacks any mention of required permissions, side effects, or result expectations. An agent has to rely on general knowledge of Jira APIs, leaving room for misinterpretation. A richer description would improve completeness.

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 already provides full descriptions for both parameters (issueKey and body), so the baseline is 3. The description adds no extra semantic value beyond the schema, such as format nuance or relationships between parameters. It neither compensates nor subtracts from the schema's coverage.

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 action ('Add a comment') and the target resource ('a Jira issue'). It is specific enough to distinguish from siblings like create_issue or update_issue, though it doesn't explicitly differentiate itself. It lacks the explicit sibling comparison that would make it a 5.

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?

There is no guidance on when to use this tool versus alternatives. With siblings like create_issue, update_issue, and transition_issue, an agent must infer when a comment is appropriate. No prerequisites or conditions are mentioned, leaving the decision entirely to the agent.

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