addPullRequestComment

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

No annotations are provided, so the description carries the full burden of disclosing behavior. It states that a comment is added and can be inline, but it does not mention permissions, side effects, whether replies are supported via parent_id, or how the inline modes affect request behavior.

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 filler. It states the core action first and appends the important scope distinction in a parenthetical.

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 tool with 8 parameters, no annotations, and no output schema, the description is too sparse. It does not explain when inline parameters are required, how replies work, or how this tool relates to the comment lifecycle, leaving the agent to infer important invocation rules.

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?

With 75% schema description coverage, most parameters are already documented. The description adds some useful context by mentioning 'general or inline on a specific file/line,' which maps to the inline_* parameters, but it does not clarify the relationships among inline_from, inline_to, and inline_path, or explain the undocumented repo_slug and workspace parameters.

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 a concrete resource ('a comment to a pull request'), and it differentiates the two modes: general comments versus inline comments on a specific file/line. This clearly distinguishes it from sibling tools like getPullRequestComments, updatePullRequestComment, and deletePullRequestComment.

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 gives no guidance on when to choose this tool over alternatives or what conditions apply. It does not mention that this creates a new comment while updatePullRequestComment modifies an existing one, nor does it clarify requirements for inline vs. general comments.

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