list_pr_comments

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

With no annotations, the description carries the full behavioral burden but only restates the operation. It does not disclose that results are paginated via the page parameter, what 'all' means with respect to pagination, or any ordering/return behavior. It is not misleading, but it reveals little beyond the basic action.

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?

A single concise sentence, front-loaded with the verb and object, with no filler. Every word earns its place.

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?

For a list tool with no output schema and no annotations, the definition should at least explain pagination and return shape. The missing page semantics and lack of usage context leave an agent guessing how to retrieve the full set of comments.

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?

The schema already describes repo_slug and pr_id, but the page parameter has no description and the tool description does not compensate. The phrase 'all comments' suggests broad scope but never explains how page interacts with retrieving all comments, leaving an agent unsure whether one call or multiple paged calls are needed.

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 identifies the exact resource ('comments on a pull request'). The word 'all' helps distinguish it from single-comment tools like get_pr_comment, and the overall purpose is immediately clear.

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 is given about when to use this tool versus siblings like get_pr_comment, add_pr_comment, or list_pull_requests. The usage context is only implicit in the verb 'List', with no exclusions, prerequisites, or alternative routing.

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