add_comment

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

With no annotations, the description carries the full burden of behavioral disclosure. It states the action but does not convey that this is a write operation, any required permissions, potential side effects, or whether the comment is appending to existing ones. This is insufficient for a mutating 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, concise sentence that is front-loaded and easy to parse. However, it is under-specified, lacking important context, which prevents a perfect score. Still, it earns a high mark for its brevity and clear 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?

Given the tool has two required parameters and no output schema, the description should at least mention the expected behavior (e.g., returns the created comment or success indicator) and any constraints. It provides only the basic action, leaving the agent without enough context to confidently invoke the tool in varied scenarios.

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 description coverage is 0%, meaning the description adds no extra meaning beyond parameter names. The parameters issueKey and comment are self-explanatory to some degree, but the description does not clarify formats, required values, or relationships. It fails to compensate for the lack of schema descriptions.

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 a comment to an issue' uses a specific verb ('Add') and resource ('comment to an issue'), clearly distinguishing it from sibling tools like get_comments (read) and create_issue (different resource). It is explicit about the action performed.

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 such as get_comments or transition_issue. There is no mention of prerequisites (e.g., issue existence) or context where adding a comment is appropriate.

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