get_diff

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

With no annotations, the description carries full burden for behavioral disclosure. It does not mention whether the operation is read-only, what kind of diff is returned (unified, name-only, etc.), or any side effects. The description adds minimal behavioral context beyond stating the obvious.

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 a single short sentence, which is concise in length, but it under-specifies the tool's purpose and behavior. It is not front-loaded with the most important action; it reads more like a label than a useful explanation.

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 three required parameters, no output schema, and no annotations, the description is inadequate for an agent to understand what the tool returns or how to invoke it correctly. It lacks information about the diff format, whether both branches and commits are acceptable, and how repo_path is used.

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%, so the description must explain parameters. It does not describe 'base', 'head', or 'repo_path' roles, leaving the agent to infer meaning from parameter names alone. No compensation for the missing schema descriptions.

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 'Diff between two branches or commits' indicates the tool computes a diff, but lacks an explicit verb like 'show' or 'get'. It names the resource (branches/commits) but does not distinguish it from sibling 'compare_branches' or 'get_pr_diff'.

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?

No guidance is provided on when to use this tool versus alternatives. Sibling tools like compare_branches or get_pr_diff likely overlap, but the description gives no context for selection.

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