list_pull_request_comments

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

Without annotations, the description carries the full burden of behavioral disclosure. It only mentions 'paginated', but does not state whether the operation is read-only, what permissions are required, or any rate limits. The read-only nature is implied but not confirmed.

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 extremely concise: a one-sentence summary followed by a structured parameter list. No superfluous information. Every element 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 straightforward paginated list tool, the description covers the basic purpose and pagination. However, it does not mention ordering, filtering, or the structure of returned comments (though output schema exists). Missing any behavioral context like read-only safety.

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. However, it only provides trivial labels like 'The project key.' which adds minimal meaning beyond the schema's parameter names and types. It fails to explain the relationship between parameters or expected formats.

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 'List comments on a pull request (paginated)', which includes the verb (List), resource (comments on a pull request), and the key behavior (paginated). This effectively distinguishes it from siblings like get_pull_request_comment (single comment) or add_pull_request_comment.

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 implies usage for listing comments, but provides no explicit when-to-use or when-not-to-use guidance relative to alternatives like get_pull_request_comment or add_pull_request_comment. The context is clear from the name, but explicit exclusions are missing.

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