get_pull_request_comments

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

No annotations are provided, so the description carries full responsibility. It only implies a read operation via 'get' but does not disclose details such as whether it requires authentication, whether it returns comments in chronological order, or whether it includes inline comments. This lack of behavioral context is a significant gap.

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 short sentence, which is concise. However, it is under-specified for a multi-faceted resource like pull request comments, and the lack of any additional structure (e.g., examples or scope clarifications) makes it feel sparse rather than efficiently complete.

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?

Given the extensive sibling list of comment-related tools (create, edit, delete, resolve, etc.), the description does not clarify which type of comments are returned or what data structure to expect. Although an output schema exists, the ambiguity around 'comments' versus 'inline comments' and the absence of any contextual cues make this incomplete.

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?

The input schema lists a single required parameter 'pull_request_id' but the description provides no explanation of what this ID refers to, how to obtain it, or any constraints. With 0% schema description coverage, the tool description fails to compensate, leaving the agent to guess the parameter's semantics.

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 'Get a pull request's comments' clearly identifies the verb (get) and resource (pull request's comments), distinguishing it from tools that operate on diffs, commits, or statuses. It does not, however, explicitly differentiate between regular comments and inline comments, given the sibling tools include create_inline_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?

There is no guidance on when to use this tool versus alternatives, no mention of scenarios like retrieving all comments versus a specific comment, and no context about related tools such as create_pull_request_comment or reply_to_pull_request_comment. The tool is simply presented without usage conditions.

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