Add Pull Request Comment

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

Annotations already show this is a write operation (readOnlyHint=false) and not destructive. The description adds useful behavioral context: support for inline comments with line references, pending drafts, and threaded replies. This goes beyond what annotations provide.

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 concise, using a single paragraph followed by a bullet list of arguments. It avoids fluff but could be slightly more structured (e.g., separating general vs inline comment use cases).

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 complexity (9 parameters) and presence of an output schema (returns created comment details), the description covers the main aspects: purpose, parameters, and general behavior. Missing prerequisites or error conditions, but adequate for most use cases.

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%, but the description fully compensates by explaining each parameter's purpose in a clear docstring format (e.g., 'repo_slug: Repository slug', 'inline_path: Path to the file for inline comments'). All nine parameters are semantically described.

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 resource ('pull request'), specifying 'general or inline'. It distinguishes from sibling tools like add_issue_comment (different resource) and update_pull_request_comment (different action).

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 implies usage for adding comments but does not provide explicit guidance on when to use this tool versus alternatives like approve_pull_request or update_pull_request_comment. No when-not-to-use or prerequisite information is given.

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