add_issue_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. 'Add a comment' at least signals a mutation, but it discloses nothing about required permissions, idempotency, rate limits, or how errors are surfaced, leaving a significant behavioral gap.

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, front-loaded sentence with no fluff. It states the verb and object directly and wastes no words, which is appropriate for a simple 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?

For a straightforward 4-parameter tool with clear types and an output schema, the description is minimal but temporarily usable. It doesn't cover optional qualifiers, error cases, or authentication expectations; adequate for basic invocation but with visible gaps.

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%, and the description names no parameters. It indirectly links 'body' to the comment content and 'issue_number' to an existing issue, but owner/repo and the relationships between fields remain entirely unelaborated at a time when the schema alone might need to do the heavy lifting.

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 an existing GitHub issue'), making the action immediately clear. It also stands apart from the read-oriented siblings (get_issue, list_issues, list_commits), so an agent can pick this tool without opening the schema.

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 context for using the tool is implied ('when you want to comment on an issue'), but the description gives no explicit when-not-to-use guidance or named alternatives. It also doesn't mention prerequisites such as authentication or that the issue must already exist.

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