get_pr_diff_hunks

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

No annotations are provided, so the description carries the burden of behavioral disclosure. It clearly states that the tool returns per-file hunks with oldStart/oldLines, newStart/newLines, and patch content, making the read-only nature and output semantics explicit enough for a retrieval 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?

Two compact sentences: the first states the action and scope, the second details the return structure. No filler or redundant information.

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 three-parameter retrieval tool, the description is complete: it names the resource, parameters are fully covered by schema, and the return structure is partially specified. It does not mention edge cases like empty diffs or authentication requirements, but these are minor for this low-complexity 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?

Schema description coverage is 100%, and each parameter has a basic description like 'Repository name' and 'Pull request number.' The description adds no additional parameter-specific meaning, so the baseline of 3 applies.

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 uses a specific verb and resource: 'Get diff hunks with line mapping for all changed files in a PR.' It clearly distinguishes itself from siblings like get_pr_files and get_pr_details by specifying diff hunks, line mapping, and inline comment placement.

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 phrase 'for accurate inline comment placement' provides clear usage context, indicating this tool is for retrieving hunk-level data needed to place comments. It does not explicitly name alternatives or state when not to use it, but the intended use case is clear.

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