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 behavioral transparency burden. It clearly identifies this as a non-mutating retrieval of a diff/patch, which is useful, but it does not mention auth requirements, possible truncation, diff format nuances, or other non-obvious behavior beyond what the output schema may expose.

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 front-loaded sentence with no filler. It states the action, the target resource, and the purpose efficiently, making it easy to scan.

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?

An output schema is present and the required parameters are clearly represented in the input schema, so basic invocation is feasible. However, the lack of annotations, parameter guidance, and alternative-tool routing makes the overall description only minimally complete for an autonomous 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 0%, and the description does not compensate by explaining owner, repo, or pull_number. The parameter names are mostly self-explanatory, but the description adds no details about how to obtain pull_number, how owner/repo should be formatted, or what the parameters semantically map to.

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 uses a specific verb ('Get') and resource ('diff/patch of a pull request') and states the intent: 'to review code changes.' This clearly distinguishes it from siblings like get_pull_request or list_pull_requests, which cover PR metadata or summaries rather than the actual patch.

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 only a light implication that the tool is for code review, but no explicit when-to-use or when-not-to-use guidance. It does not name alternatives such as get_pull_request for metadata or list_pull_requests for finding PRs, so an agent gets no help choosing between these tools.

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