add_pr_comments

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

Annotations already indicate readOnlyHint=false, so the description's confirmation that this is a write operation adds little value. The description does not disclose any additional behavioral traits such as notification side effects, comment formatting constraints, or whether the operation is idempotent, which would be useful for an agent.

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, concise sentence with no fluff. However, it is too brief to fully serve the agent's needs, lacking essential context such as sibling differentiation. It is front-loaded but could be expanded slightly to include usage hints without becoming overly verbose.

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?

Given the tool's simplicity and the presence of an output schema, the description is minimally adequate for a basic 'add comment' action. However, the lack of differentiation from the inline comment sibling and the omission of parameter semantics make it incomplete for an agent to reliably select and invoke the tool without further context.

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 0% schema description coverage, the description should compensate by explaining parameter meanings or constraints. It does not, though the parameter names ('repo_owner', 'repo_name', 'pr_number', 'comment') are reasonably self-explanatory. Missing details like required format for the comment string or numerical range for pr_number reduce clarity.

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 clearly states the verb and object ('Adds a comment to a specific pull request'), making the tool's purpose immediately understandable. However, it does not differentiate this tool from its sibling 'add_inline_pr_comment', which could cause confusion in selecting the correct tool for adding general vs inline comments.

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 provides no guidance on when to use this tool versus the sibling 'add_inline_pr_comment' or any prerequisites (e.g., required permissions). This lack of context forces the agent to rely solely on the tool name to infer usage, increasing the risk of selecting the wrong tool.

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