add_comment

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

No annotations are provided, so the description carries the full burden. It states 'Add a comment' implying mutation, but does not disclose any behavioral traits such as required permissions, reversibility, rate limits, or impact. The external docs link is helpful but not a substitute for inline disclosure.

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?

One sentence that accomplishes the purpose, followed by a documentation link. No wasted words. Excellent conciseness.

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 tool is simple, but with no annotations and no output schema, the description could have mentioned return behavior or preconditions (e.g., issue must exist, write access required). The docs link provides external depth, but the inline description is minimal and leaves the agent to infer operational details.

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 100%, so the schema fully documents each parameter. The description adds no additional parameter-level detail, which is acceptable per the baseline. No gaps to compensate for.

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 uses a specific verb ('Add') and resource ('comment to a GitHub issue'), clearly distinguishing this from sibling tools like 'list_comments' (read) and 'create_issue' (different resource). It is unambiguous and matches the tool name.

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 intended use is immediately clear: to add a comment to an existing issue. It provides clear context but does not explicitly mention when not to use it or alternatives. Given the tool's simplicity, this is sufficient, though it could have noted that this is for adding a new comment rather than listing or editing.

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