add_pull_request_comment

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

No annotations are provided, so the description is the only source of behavioral context. It discloses that the tool writes a comment, returns a 'Normalized write-result mapping', and that raw includes the provider payload. However, it does not cover permissions, reversibility, side effects, or rate limits.

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 compact and well-structured with labeled Args, Returns, and Examples sections. The example input/output is useful and adds concrete context. The only minor redundancy is that the first line restates the tool name.

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 write tool with an output schema, the description provides enough to make an initial call: all parameters are listed, an example is given, and the return shape is summarized. However, missing provider-key vocabulary and repo/pull_request_id format details leave room for incorrect invocation.

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%, so the Args block must compensate, but it mostly restates parameter names: 'provider: Provider key' and 'repo: Repository identity' are vague, while only 'body: Comment text' and 'raw: Include the provider payload' add real meaning. Accepted provider keys and repo/pull_request_id formats are not specified.

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 opening sentence clearly states the action and resource: 'Add a comment to a pull request.' This makes the tool's purpose obvious and distinguishes it from sibling list/merge/review operations, though it does not explicitly contrast it with submit_pull_request_review.

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?

There is no guidance about when to use this tool versus alternatives like list_pull_request_comments or submit_pull_request_review, and no exclusions or prerequisites are mentioned. The example implies use when posting a comment, but that is inferred rather than stated.

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