list_pr_comments

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

No annotations are provided, so the description carries the burden of behavioral disclosure. It states the tool list comments (a read operation) but does not mention any authentication requirements, side effects, or rate limits. The description is adequate for a simple read tool with an output schema, but greater transparency about pagination or error scenarios would be beneficial.

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 and well-structured: a one-sentence summary, a clarifying sentence, a sibling reference, and a clean parameter list. Every sentence adds value, and the information is front-loaded.

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 tool has 3 simple required parameters and an output schema (which presumably defines return fields), the description is complete for its complexity. It clarifies the scope of comments and excludes review threads. A slight deduction for not specifying whether the output includes pagination or ordering.

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%, meaning the schema provides no descriptions for the three parameters. The description includes a docstring-style list that restates 'owner', 'repo', and 'pr_number' with minimal context (e.g., 'Repository owner'), but does not explain the format required for each (e.g., username, string patterns, value ranges). Since the schema does not help and the description lacks detail, the score is low.

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 tool lists 'general thread comments on a pull request (conversation tab)' and distinguishes these from 'inline review comments on the diff', which is a specific verb+resource combination. It correctly differentiates from sibling tools like list_unresolved_review_threads, which is aimed at inline code reviews.

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 explicitly tells when to use this tool (for top-level comments on the conversation tab) and when not to use it (for inline code review comments). It directly names the alternative sibling tool list_unresolved_review_threads for the latter case, providing clear usage guidance.

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