get_pull_request_diff

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

With no annotations available, the description carries the full burden of disclosure. It mentions support for text and JSON formats, but does not describe any default behavior, side effects (likely none), authentication requirements, or limitations. The 'Get' verb implies a read-only operation, but this is not explicitly stated.

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 concise two-sentence summary. The first sentence states the action, the second explains the two primary options. No filler or redundancy exists.

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?

Despite being concise, the description lacks coverage of advanced options such as sinceId/untilId for ranged diffs, whitespace handling, or contextLines to control verbosity. Since there is no output schema to describe the return structure, the text/JSON mention is helpful but incomplete. The description is sufficient for a simple full-diff call but not for complex scenarios.

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 already provides descriptions for all 9 parameters (100% coverage), giving a solid baseline. The description adds value by clarifying the key `path` parameter (omit for full diff) and the `format` parameter (text vs JSON), which directly maps to the schema. Other parameters like sinceId/untilId and contextLines are not touched, but the schema covers them.

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's core purpose ('Get diff for a pull request') and immediately explains the two usage modes (full diff vs. single file via path). However, it does not explicitly distinguish itself from the sibling tool get_pull_request_file_diff, which may offer overlapping functionality.

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 context by explaining how to control output (path, format), but it does not provide explicit guidance on when to prefer this tool over alternatives like get_pull_request_changes or get_pull_request_file_diff. It gives parameter-level usage instructions but no tool-selection heuristics.

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