Add Jira Comment

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

With no annotations, the description carries the full burden of disclosing safety and side effects, but it only states the basic action. It does not mention whether authentication is required, whether the operation is reversible, or what the response contains, making the tool's behavior opaque.

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 sentence with no extraneous words, making it highly concise. However, the extreme brevity under-specifies the tool, leaving gaps that reduce its overall effectiveness despite the clean structure.

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, no output schema, and undocumented parameters, the description is incomplete. It does not address when to use the tool, parameter semantics, or behavioral expectations, leaving the agent under-informed for correct invocation.

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 has two required string parameters with zero description coverage. The description does not elaborate on the meaning, format, or expected values of `issueKey` or `comment`, failing to compensate for the absence of schema-level documentation.

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 'Add comment to issue' clearly states the action (add) and the target (comment to issue), distinguishing it from sibling tools like search, create, and transition. This is a specific verb+resource combination that leaves no ambiguity about the tool's function.

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?

No guidance is provided about when to use this tool relative to alternatives such as jira_transition_issue or jira_create_issue. The description does not mention prerequisites, exclusions, or appropriate contexts, leaving the agent without selection guidance.

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