get_pr_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 discloses the return type (string) and error conditions (GitHubNotFoundError, GitHubAPIError), but lacks details on side effects, authentication requirements, or rate limits.

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 structured as a docstring with clear sections (Args, Returns, Raises). It is concise and front-loaded with the main purpose, though the format adds a few extra words.

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?

For a simple tool with 3 parameters and a string return, the description covers purpose, parameters, return type, and errors. It is largely complete, but omits context like authentication prerequisites or that the operation is read-only.

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?

With 0% schema coverage, the description provides essential parameter documentation: each parameter is described with its type and role (e.g., 'The owner of the GitHub repository'). It adds meaning beyond the raw schema, though it could include examples or constraints.

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 specific action ('Fetches the diff/patch') and resource ('pull request from a GitHub repository'). It is distinct from sibling tools like get_pr_content, which fetches content rather than the 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 the tool is for retrieving a diff/patch, but it does not explicitly state when to use this tool versus alternatives (e.g., get_pr_content for full content) or when not to use it.

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