add_pull_request_comment

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

There are no annotations, so the description carries the full behavioral burden, yet it says nothing about permissions required, that this is a mutating write operation with side effects (e.g., notifications to PR participants), or whether the comment can be edited/removed afterward. It only discloses the structural variants of the 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?

A single front-loaded sentence that wastes no words and puts the core action first with the variants in parentheses. Appropriately sized for the operation.

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 an 8-parameter mutation with no output schema and no annotations, the description omits key interaction rules such as which parameters are required for inline vs reply modes. The schema documents each parameter, so the gap is not critical, but the mode-to-parameter mapping an agent needs is left to inference.

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 baseline is 3. The description loosely maps the three modes onto parameter sets (inline needs filepath/line, reply needs parent_comment_id), but it adds no syntax, constraints, or dependency rules beyond what the schema already documents.

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?

States a clear verb and resource ('Add a comment to a pull request') and goes further by naming the three comment modes (general, inline, reply). No sibling tool in the list creates comments, so differentiation is implicit rather than stated, which keeps it just below a 5.

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 three modes imply which path to take, but the description never says when to use inline vs general vs reply, nor which parameters select each mode. Usage is implied by the enumerated modes rather than stated explicitly.

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