compare_branches

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

With no annotations provided, the description carries the burden of disclosing behavior. It explains the directional filtering (commits in target not in base), but does not explicitly state that the operation is read-only, mention side effects, permissions, or output limitations like pagination defaults.

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, front-loaded sentence that is direct and informative. The parenthetical use case adds value without unnecessary fluff.

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?

The description covers the primary behavior and use case, and the schema fully documents all parameters. However, with no annotations or output schema, some details like result ordering or the role of the 'top' parameter default are left implicit. Overall, the combination is adequate but not exhaustive.

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%, and the description adds semantic meaning by clarifying how baseBranch and targetBranch relate to the output ('commits in target that are not in base'). It does not elaborate on optional parameters, but those are already described in the schema.

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 function with a specific verb ('Compare'), the resource ('two branches'), and the exact result ('shows commits in target that are not in base'). This differentiates it from sibling tools like list_commits and get_commit_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?

The description provides a clear context for use ('useful for regression analysis') but does not explicitly mention alternatives or when not to use this tool. This fits 'clear context, no exclusions' on the scale.

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