get-pr-diff

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

With no annotations, the description carries the full burden and discloses almost nothing: not whether the diff is returned raw or parsed, whether large diffs are truncated, whether it requires authentication or specific permission scopes, or whether it is read-only (implied by 'Get'). Nothing about failure modes or size limits is 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?

A single front-loaded sentence with no filler or redundancy. It is efficient, though its brevity is partly the cause of the missing behavioral detail rather than a sign of disciplined scoping.

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?

There is no output schema, so the description is the only place to learn what comes back, and it says nothing about return shape, truncation, or diff format. For a read tool whose output is the entire point, that leaves a significant gap even though the call itself is simple.

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 coverage is 100%, so all three parameters including the workspace env-var fallback are already documented in the schema. The description adds no format hints (e.g., whether pull_request_id is the numeric internal ID) beyond what the schema provides, which is the baseline expectation at full coverage.

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?

States a specific verb and resource: 'Get the diff/changes' for 'a specific pull request'. An agent immediately knows this retrieves PR diffs. It does not differentiate from siblings, but no listed sibling appears to expose diffs, so the name-plus-description pairing is unambiguous.

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, no mention of prerequisites (e.g., needing repo_slug and pull_request_id together), and no named alternative. The only usage signal is the implied 'you must have a pull request', which an agent could infer from the name alone.

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