Skip to main content
Glama

branch.diff

Read-onlyIdempotent

Two-way schema diff between two environments of a project. POST /v1/organizations/{id}/projects/{project}/branches/diff.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "organization_id": "<organization_id>",
      "project_id": "<project_id>",
      "base": "<base>",
      "head": "<head>"
    },
    "name": "branch.diff"
  }
}

Input Schema

NameRequiredDescriptionDefault
baseYesbase (required)
headYeshead (required)
project_idYesproject_id (required)
organization_idYesorganization_id (required)

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.4/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint, non-destructive, and closed-world, so the safety profile is covered. The description contributes the "two-way" (direction-agnostic) semantics and the underlying POST endpoint, but says nothing about diff size, output shape, or what happens when the branches are identical — modest value beyond the annotations.

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

Conciseness4/5

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

Two short sentences, front-loaded with the operation and followed by the endpoint. The REST path is arguably redundant filler for an agent, but nothing is bloated and the core statement comes first.

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

Completeness3/5

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

For a four-required-parameter read operation with no output schema, the description should say what a diff result contains (schema objects added/removed/changed) and what base/head actually reference. It covers the gist but leaves an agent guessing about the return value and parameter identity.

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 coverage is nominally 100%, so the baseline is 3, but the schema descriptions are pure placeholders ("base (required)"). The description adds only the word "two-way", which hints that base/head ordering may not affect the result; it never explains that base and head are the two branch/environment identifiers being compared.

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?

"Two-way schema diff between two environments of a project" gives a specific verb (diff) and resource (schema between environments), which is more precise than the bare name branch.diff. It does not explicitly distinguish itself from nearby siblings such as branches.merge, branch.merge, or schema.propose, so it stops short of a 5.

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

Usage Guidelines3/5

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

Usage is only implied: an agent can infer this is the comparison step before a merge or apply, but the description never says when to call it, when not to, or which sibling to use instead (e.g. branches.merge for actually applying changes). No prerequisites or exclusions are stated.

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

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources