Skip to main content
Glama

compare_branches

Compare two branches to reveal overlapping files and show the differences between them, helping identify conflicts before merging.

Instructions

Compare two branches — show overlapping files and the diff between them

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
branch_aYesFirst branch name
branch_bYesSecond branch name

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

B3.4/5.0
Behavior3/5

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

With no annotations provided, the description carries the full burden. It usefully discloses the expected output (overlapping files and a diff), but does not state that the operation is read-only, whether branches must exist, or any permission or rate-limit behavior.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness5/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single front-loaded sentence with no wasted words. It is appropriately sized for a simple two-parameter tool.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a simple comparison tool with fully described parameters and no output schema, the description does explain the intended output. However, it omits explicit usage guidance and a read-only assurance, leaving small gaps given the absence of annotations.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the two branch parameters are already fully documented in the schema. The description adds only the high-level phrase 'two branches' and no additional syntax or format meaning beyond the structured fields.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource: compare two branches and show overlapping files and diff. The purpose is clear without opening the schema, but it does not explicitly differentiate itself from nearby siblings like detect_conflicts, review_code, or track_branches.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines2/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description only states what the tool does; it gives no explicit when-to-use guidance, no prerequisites, and no alternatives. Usage is left entirely to inference from the name and purpose.

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