get_pr_comments

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

With no annotations, the description must disclose behavioral traits. It claims to list 'all' review comments but does not mention pagination (which is implied by the 'page' and 'per_page' parameters), authentication requirements, or the read-only nature. The overstatement of 'all' without noting pagination is misleading.

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 redundant words. It is appropriately sized for a simple tool, though it could include more actionable details without becoming bloated.

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?

The tool has 5 parameters and no output schema or annotations. The description does not cover pagination behavior, return format, or the specific type of comments (inline code review vs. general issue comments). This is insufficient for a tool with non-trivial parameters and no structured metadata to rely on.

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 description must compensate for parameter explanations. It fails to mention any parameters or their roles. The schema itself is self-explanatory, but the description adds no value beyond it, leaving the agent to infer required inputs without any textual support.

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 uses a specific verb ('List') and a clear resource ('review comments on a pull request'), making the tool's purpose unambiguous. However, it does not explicitly differentiate from sibling tools like list_issue_comments or add_pr_review_comment, so it falls short of a 5.

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 alternatives. It does not mention that this is for retrieving inline code review comments, nor does it distinguish from list_issue_comments or other PR-related tools. No exclusions or alternative suggestions are given.

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