bitbucket_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 full burden. It states it returns a diff, notes platform differences, and raises ValueError if client is not configured. It does not explicitly mention that it is a read-only operation or discuss rate limits, but the behavior is reasonably clear for a read tool.

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 well-structured: a clear first sentence, followed by explanation of output, platform differences, parameters, returns, and raises. No superfluous information; each sentence serves a purpose.

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 the presence of an output schema (not shown), the description reasonably covers the return format and platform differences. It lacks details on handling large diffs or pagination, but overall is sufficient for a diff retrieval tool.

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?

The input schema has 100% coverage with descriptions for all three parameters. The description repeats the parameter names without adding additional meaning or constraints beyond what the schema already provides, so it does not add value.

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 returns the full code diff for a pull request, using specific verbs and resource. However, it does not explicitly distinguish from sibling tools like `bitbucket_get_pull_request` or `bitbucket_get_commit_changes`, which could also be related to code review.

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 usage for reviewing code changes in a PR but does not provide explicit guidance on when to use this tool versus alternatives (e.g., when to use `bitbucket_get_pull_request` for metadata only). No exclusion criteria are given.

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