list_pr_comments

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

Annotations already declare readOnlyHint=true and destructiveHint=false, covering the safety profile. The description adds behavioral context by specifying 'fully paginated' and clarifying the scope ('every comment (inline and general)'), which goes beyond the annotations. This is useful and not contradictory.

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. It states the action, scope, and a key requirement efficiently.

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?

With no output schema and 0% parameter coverage, the description is incomplete. It does not describe the return format, the exact meaning of `repo`, or the required `pr_id`. An agent would need to infer parameter semantics from the schema alone, and the description lacks enough context for a complex list operation.

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. It mentions the `repo` argument but does not explain what it represents (though the schema shows it references `workspace`). The `pr_id` parameter is not described at all. The description adds minimal semantic value beyond the schema, failing to clarify parameter formats or meaning.

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 verb (Lists), the resource (every comment on a pull request), and the scope (inline and general, fully paginated). It distinguishes itself from sibling tools like create_pr_comment (write) and get_pull_request (overview) by focusing on listing 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 mentions a requirement ('Requires an explicit `repo` argument') but does not explicitly state when to use this tool versus alternatives. It implies a listing scenario but lacks explicit when/when-not guidance or references to sibling tools. The purpose is clear enough that an agent can infer usage, but explicit guidance is missing.

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