Get Changes Between Refs

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

No annotations are provided, so the description carries the burden. It mentions it uses the GitHub compare API, implying external call behavior, but does not disclose rate limits, pagination, or whether it includes unmerged commits. It also doesn't clarify data volume or potential errors.

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 sentences, concise and front-loaded with the core purpose. The mention of the GitHub compare API adds context without verbosity. Could trim 'enriched with' but overall efficient.

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 read-only list tool with 4 well-documented required params and no output schema, the description is adequate but not comprehensive. It doesn't specify return format, pagination, or how commits are ordered, which could be important for large comparisons. Sibling tools exist, but no exclusions are given.

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 coverage is 100%, with each parameter described (base/head as refs, owner/repo). The description adds a bit of context by clarifying base is older and head is newer, which is helpful. But it does not add syntax examples or constraints beyond schema, so baseline 3 is appropriate.

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?

Description clearly states it gets all commits between two refs with enriched metadata (PR, author, issues) using the GitHub compare API. It distinguishes from siblings by specifying refs rather than PRs or releases, but could more explicitly contrast with get_pull_requests_in_range.

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?

It mentions using refs (tags/branches/SHAs) which implies use cases like comparing releases or branches. However, it lacks explicit guidance on when to use this over get_pull_requests_in_range or get_release_summary, and no mention of when not to use it.

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