get_pull_request_comments

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

No annotations provided, so description bears full burden. It correctly indicates the tool is read-only (get) and non-destructive. It clarifies the scope (both general and inline comments). Missing details like pagination or ordering, but overall transparent for a read operation.

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?

Very concise: three sentences plus a minimal Args/Returns section. Every sentence provides useful information without redundancy. The structure separates purpose, usage, and parameter descriptions clearly.

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 simple list tool with an output schema, the description is thorough enough. It explains input parameters with defaults and context, and briefly describes what is returned (list of comments with content, authors, locations). Could mention ordering or pagination, but sufficient for typical use.

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 coverage is 0%, but description adds value by explaining each parameter's purpose and default behavior (e.g., repository and workspace fallback to current context). This goes beyond the schema, which only has types and titles.

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 'Get all comments on a pull request' with a specific verb and resource. It distinguishes from sibling tools like 'add_pull_request_comment' and 'get_pull_request' by specifying it retrieves comments, including both general and inline code review 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 explicitly says 'Use this tool to review comments, feedback, and discussions on a pull request.' This provides clear usage context. While it doesn't explicitly list when not to use or alternatives, the sibling context and comments about inclusion of both comment types give adequate guidance.

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