get_pull_request_diff

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

No annotations are provided, so the description carries the full burden. It states 'Get the diff', indicating a read operation, but does not disclose details such as whether it returns inline diff or summary, or any side effects (none expected). The description lacks additional behavioral context beyond the obvious read.

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 concise sentence that front-loads the key action and purpose. It is efficient with no wasted words, though it could potentially include a bit more context without becoming verbose.

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 low complexity of the tool (3 required params, no output schema), the description provides the essential purpose. However, it does not mention the return format (e.g., unified diff) or any nuances, which would improve completeness for an agent.

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 100% for all three parameters with clear descriptions (e.g., 'The repository slug', 'The project key', 'The pull request ID'). The description adds no additional meaning beyond what the schema provides, so baseline score of 3 is appropriate.

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 verb 'Get' and the resource 'diff of a pull request', and specifies the context 'for code review'. It differentiates from sibling tools like get_file_diff (file-specific) and get_pull_request_detail (details, not diff).

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 code review but does not explicitly state when to use this tool versus alternatives (e.g., get_file_diff for individual file diffs, get_pull_request_comments for comments). No when-not or exclusions are provided.

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