get_commit_diff

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

With no annotations provided, the description carries the full burden of behavioral disclosure. It effectively describes key traits: it returns 'raw git diff output' in JSON format, implies it's a read-only operation (no mention of mutations), and specifies it works with GitHub repositories. However, it lacks details on error handling, rate limits, or authentication needs, which are relevant for GitHub API tools.

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 with sections for purpose, usage guidelines, parameters, returns, and an example. It's front-loaded with the core purpose. However, it includes some redundancy (e.g., repeating parameter info in the example) and could be slightly more concise by integrating the example more tightly.

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 tool's moderate complexity (3 parameters, no annotations, no output schema), the description is largely complete. It covers purpose, usage, parameters, and return format. However, it lacks details on output structure (beyond 'JSON with raw git diff content'), error cases, or GitHub API specifics, leaving minor gaps for an agent to invoke it fully correctly.

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 schema description coverage is 0%, so the description must compensate fully. It provides detailed semantics for all three parameters: 'repo' as 'owner/repo' format with an example, 'base' as 'commit SHA, branch name, or tag' with examples, and 'head' similarly. This adds essential meaning beyond the bare schema, clarifying acceptable values and formats.

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's purpose: 'Get the diff between two commits, branches, or tags in a GitHub repository.' It specifies the verb ('Get'), resource ('diff'), and scope ('GitHub repository'), distinguishing it from siblings like get_file_content or get_repo_tree that fetch different repository data.

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 explicitly includes 'USE THIS WHEN: You need to see what changed between two versions of code' and 'BEST FOR: Analyzing changes, reviewing pull requests (by comparing branches), or checking version differences.' This provides clear context for when to use this tool versus alternatives, such as for diff analysis rather than content fetching.

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