getPullRequestComments

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

No annotations are provided, so the description must carry the full disclosure burden. It conveys read-only intent through the verb 'List', but it fails to disclose pagination behavior, ordering, authorization requirements, or whether comments are in-line review comments versus general PR comments.

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 wasted words. It is appropriately short, but it errs on the side of under-specification.

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 tool with five parameters, pagination options, and no output schema, the description is thin. It does not explain how pagination works, what workspace/repo_slug are used for, or how this differs from similar list-style siblings, leaving agents to infer critical call details.

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?

With only 20% schema description coverage, the description needed to compensate but adds no explanation beyond what the schema already shows. page, pagelen, repo_slug, and workspace are left undefined, despite being essential for correctly constructing the request.

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-resource pair ('List all comments on a pull request') that clearly identifies the operation. It distinguishes itself from add/update/delete comment siblings, though it isn't explicitly differentiated from getPullRequestActivity.

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?

There is no guidance on when to use this tool versus alternatives or on prerequisite context. The description implies usage ('when you need comments'), but it doesn't mention closer siblings like getPullRequestActivity or explain when chosen over them.

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