add_pull_request_comment

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

With no annotations, the description carries full burden. It only states 'Add a comment' without disclosing key behaviors: whether it creates new threads or replies, or side effects like permissions required. The agent lacks insight into comment creation mechanics.

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 waste. However, it could benefit from slightly more structure, e.g., separating threading and file comment modes.

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 10 parameters and no output schema or annotations, the description is too minimal. It omits essential context about thread creation, file commenting, status usage, and reply behavior, leaving an AI agent underinformed for correct usage.

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 coverage is 100%, so description adds only minimal value: repeating that repositoryId can be derived. It does not explain complex parameters like threadId vs filePath/lineNumber, but baseline is 3 due to full 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 ('Add a comment') and the resource ('pull request'), with a useful note about repositoryId derivation. It distinguishes from sibling tools like create_pull_request and get_pull_request_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 offers a hint about repositoryId being optional but does not specify when to use this tool versus alternatives like update_pull_request or how to handle threading vs file comments. No explicit when-not or alternative references.

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