get_commit_diff

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

With no annotations, the description carries the full burden. It does disclose the return format (unified diff) and that all changes are shown, which is useful. However, it does not mention authentication requirements, rate limits, potential for large payloads, or any side effects, which would help fully set expectations.

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 two short sentences with no filler. The key purpose is first, and the output format is second. Every word earns its place.

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 relatively simple read-only tool with a fully documented schema, the description provides the essential purpose and output format. It could be improved by explicitly noting that this complements get_commit (which likely returns metadata) or mentioning any output size limitations, but these are minor given the strong context signals.

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%, so the baseline is 3. The description adds no additional meaning for the parameters beyond what the schema already provides; it only states the tool's overall intention.

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 ('Get'), a specific resource ('the diff/patch of a specific commit'), and states the output format ('unified diff'). It clearly distinguishes this tool from sibling tools like get_commit by specifying the diff/patch content rather than commit metadata.

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 the tool should be used when a commit's diff is needed, but it does not explicitly state when to use it versus alternatives such as get_commit or list_commits. There are no exclusions or comparisons with sibling tools, leaving the routing decision to inference.

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