add_pr_comments

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

Annotations provide basic read/write hints but description adds no behavioral context beyond 'adds'. Missing details on whether comment is posted immediately, if it can be deleted, or what happens on failure. This is insufficient given the lack of annotation depth.

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?

Minimally concise with one sentence, but sacrifices valuable information. Could be restructured to include essential details without significant length increase.

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?

Despite the presence of an output schema (not shown), the description omits return value information. With many sibling tools, the lack of differentiation and context leaves the description incomplete for a 4-parameter tool.

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 has 0% description coverage and the description provides no parameter-level meaning. For example, 'comment' could have formatting constraints that are unstated. The description does not compensate for the missing schema descriptions.

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 action (adds a comment) and the resource (specific pull request). It is a specific verb+resource pair that distinguishes it from siblings like 'add_inline_pr_comment' which implies a different comment type.

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?

No guidance on when to use this tool versus alternatives such as 'add_inline_pr_comment' for line-specific comments. No context on prerequisites or effects, so agents lack decision support.

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