get_pull_request_comments

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

With no annotations, the description carries full burden for behavioral disclosure. It only states the output type but does not mention pagination, ordering behavior, rate limits, or what happens when no comments exist. The 'order' parameter suggests sorting, but the description fails to clarify behavior.

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, clear sentence with no redundant content. It is appropriately front-loaded. However, it may be too minimal, but conciseness as a dimension rewards efficiency.

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 high parameter count (10) and no output schema or annotations, the description is insufficient to guide effective use. It does not explain the role of optional parameters or the expected output format, leaving agents without enough context.

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 100%, so the baseline is 3. The description adds no additional meaning beyond the parameter descriptions in the schema. It does not explain how parameters like 'minId' and 'maxId' work together for filtering.

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 the tool returns a list of comments for a pull request, using a specific verb and resource. However, it does not explicitly distinguish itself from sibling 'get_issue_comments', which also retrieves comments but for issues. The purpose is clear but could be more distinct.

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?

No guidance is provided on when to use this tool versus alternatives like 'get_issue_comments' or how to set it up. There is no mention of prerequisites such as needing a valid pull request number or project context.

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