add_comment

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

With no annotations and no description of side effects, permissions, idempotency, or return behavior, the description fails to disclose what happens when the tool is invoked. This is especially problematic for a write operation like adding a comment.

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 extremely concise and contains no unnecessary words. It is a single clear sentence. However, its brevity comes at the cost of omitting essential details, so it is not maximally effective despite being succinct.

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?

The description lacks any context about the 'issue' entity, the expected input format, the result of the operation, or any related constraints. It provides insufficient information for an agent to use the tool correctly in a real workflow.

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 does not include descriptions for any parameters (public_id, body, author), and the tool description also does not explain what each parameter means or how they should be used. The agent receives no semantic information beyond the bare parameter names.

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) and the object (a comment to an issue), which distinguishes it from siblings like create_issue or update_issue. However, it does not elaborate on the nature of the issue or any additional context, so it is not maximally explicit.

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?

The description provides no guidance on when to use this tool versus the sibling tools, nor does it mention any prerequisites, constraints, or typical scenarios. It is a bare statement with no usage context.

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