get_pr_diff

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

No annotations are provided, so the description carries full burden. It states the tool returns 'Diff content as text' which adds some behavioral context about output format. However, it doesn't disclose important traits like whether this is a read-only operation, authentication requirements, rate limits, error conditions, or pagination behavior for large diffs.

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 appropriately sized with three sentences that each serve a purpose: stating the tool's purpose, listing parameters, and describing the return value. It's front-loaded with the core functionality. Minor improvement could be made by combining the parameter documentation into a more structured format.

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 2 parameters with 0% schema coverage and no output schema, the description provides basic parameter documentation and return format. However, for a tool that fetches potentially complex diff data, it lacks details about diff format specifics, size limitations, error handling, and authentication requirements that would be needed for robust usage.

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%, so the description must compensate. It documents both parameters ('repo_slug' and 'pr_id') with brief explanations, adding meaning beyond the bare schema. However, it doesn't provide format details (e.g., what constitutes a valid repo_slug), examples, or constraints, leaving gaps in parameter understanding.

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 purpose with a specific verb ('Get') and resource ('diff of a pull request'). It distinguishes from siblings like 'get_pull_request' by focusing on the diff content rather than general PR information. However, it doesn't explicitly contrast with 'compare_commits' which might also provide diff-like 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?

No guidance is provided about when to use this tool versus alternatives. The description doesn't mention prerequisites, appropriate contexts, or comparisons to sibling tools like 'get_pull_request' (for general PR info) or 'compare_commits' (for commit diffs). Usage is implied but not explicitly stated.

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