compare_branches

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

The description discloses the core behavior (computing ahead/behind counts) and implies a read-only operation. However, with no annotations, it does not clarify whether the counts are commit-based, whether remote fetching occurs, or any side effects beyond the schema's repo_path.

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 with no filler, fully front-loaded, and to the point. Every word earns its place, making it highly concise.

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?

No output schema exists and annotations are absent, so the description must explain the return shape and operational context. It only says 'counts' without specifying whether these are commit counts, and it omits prerequisites like local repository state or whether branches must exist.

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%, and the description only mentions 'between two branches,' which maps to branch_a and branch_b but adds no detail about ordering or repo_path. The parameter names are self-explanatory, but the description fails to clarify whether ahead/behind is relative to branch_a or branch_b.

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 that the tool computes ahead/behind counts between two branches, which is a specific and distinguishable operation. It distinguishes itself from sibling 'get_diff' by focusing on counts rather than diff content, though it lacks an explicit verb like 'returns'.

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 such as get_diff or list_commits. The description does not mention any exclusions, prerequisites, or scenarios for use, leaving the agent without direction.

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