add_comment

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It states the action is to 'add' a comment, implying a write operation, but doesn't cover critical aspects like authentication requirements, permission levels, rate limits, error conditions, or whether the comment is editable after creation. 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 efficiently structured with a clear purpose statement followed by parameter explanations. Every sentence adds value without redundancy, and it's front-loaded with the core functionality. The brevity is appropriate for this straightforward tool.

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's moderate complexity (2 parameters, mutation operation) and the presence of an output schema (which handles return values), the description is minimally adequate. However, it lacks behavioral details (e.g., side effects, error handling) and usage guidelines, making it incomplete for safe and effective agent use without additional 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?

The description adds meaningful context beyond the schema, which has 0% description coverage. It clarifies that 'issue_key' follows a specific format (e.g., 'PROJ-123') and that 'comment' is text to add, providing practical usage hints. However, it doesn't detail constraints like comment length or special characters, leaving some ambiguity.

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 target resource ('to a Jira issue'), making the purpose immediately understandable. However, it doesn't differentiate this tool from sibling tools like 'update_issue' which might also allow comment modifications, leaving room for ambiguity in tool selection.

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 on when to use this tool versus alternatives. The description doesn't mention prerequisites (e.g., needing issue access), compare it to similar tools like 'update_issue', or specify use cases (e.g., for adding feedback versus updating status). This leaves the agent without contextual decision-making support.

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