list_pull_request_comments

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

With no annotations present, the description carries the behavioral burden. It explains that results are a 'Page mapping containing normalized comment items,' that pagination is one-based and limited, and that raw provider payloads can be included. This is meaningful behavioral detail for a read-only list operation, though sort order and error behavior are not covered.

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 compact, uses a clear Args/Returns/Examples structure, and includes a concrete input/output pair that demonstrates the expected shape. No sentence is redundant or filler.

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 read-only paginated list operation, the description covers all required parameters and the return shape. It is missing only explicit usage-selection guidance and minor details like page_size defaults and possible provider-specific constraints, but schema defaults cover the numeric defaults.

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 descriptions are absent (0% coverage), but the Args section documents all six parameters with useful semantics, including the one-based page, the 1-100 page_size bound, and the effect of raw. This fully compensates for the bare JSON schema.

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 opens with a specific verb and resource: 'List comments attached to a pull request.' This clearly identifies the object (comments) and scope (pull request), and distinguishes it from sibling tools like list_pull_request_commits and list_pull_request_reviews by the artifact type.

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 rather than a sibling such as list_pull_request_reviews or list_pull_request_commits, and no exclusions or prerequisites are stated. The example shows an invocation but not the selection criteria, so usage is left entirely to the agent's inference.

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