get_pull_request_diff

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

With no annotations, the description carries the full disclosure burden, and it does add meaningful behavioral context: the diff is "bounded" and "redacted", telling the agent output may be truncated and sanitized. However, it omits any mention of permissions, size limits, or pagination behavior that a mutating-adjacent read tool would warrant.

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?

It is a single short sentence with zero waste, which is structurally clean, but the brevity borders on under-specification rather than efficient conciseness.

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 exists so return values need not be explained, but the definition still leaves three undocumented parameters, no usage routing, and no annotations to lean on. For a 3-parameter tool with no structured behavioral coverage, this is inadequate.

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% for three required parameters (owner, repo, number), and the description does not describe any of them. An agent gets no meaning for what these parameters expect beyond their bare names in the schema.

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 states a verb+resource ("Get a ... unified diff") but only the tool name ties it to pull requests; the description itself never mentions a PR, owner, repo, or number. It distinguishes itself somewhat with the qualifiers "bounded, redacted", but an agent reading only the description cannot fully identify the target resource.

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 no when-to-use or when-not-to-use guidance and no mention of sibling tools like get_pull_request_files or get_pull_request, which also surface PR content. The agent must infer usage from the tool name alone.

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