Skip to main content
Glama

version_diff

Read-onlyIdempotent

Generate a read-only unified text diff between two stored versions of editable files after digest verification, enabling review of candidate changes before proposing or gating.

Instructions

Show the unified text diff of editable files between two stored versions, after verifying both snapshots' content digests. Use it to review a candidate before proposing or gating; use compare_paired to compare measured outcomes instead. Read-only. Returns {parent, child, changed, diff}; binary files are named, not diffed.

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": {
      "config": "<config>",
      "parent": "<parent>",
      "child": "<child>"
    },
    "name": "version_diff"
  }
}

Input Schema

NameRequiredDescriptionDefault
childYesVersion after the change: 64-character lowercase SHA-256 version id, as returned by version_create.
configYesPath of the scenario YAML file on the server host, absolute or relative to the server's working directory, for example `scenario.yaml`. It selects the workspace; a server started with --config rejects any other path.
parentYesVersion before the change: 64-character lowercase SHA-256 version id, as returned by version_create.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed3 schema fields changedv0.1.9
    • addedInput schema / properties / child / description
      Added value: +"Version after the change: 64-character lowercase SHA-256 version id, as returned by version_create."
    • addedInput schema / properties / config / description
      Added value: +"Path of the scenario YAML file on the server host, absolute or relative to the server's working directory, for example `scenario.yaml`. It selects the workspace; a server started with --config rejects any other path."
    • addedInput schema / properties / parent / description
      Added value: +"Version before the change: 64-character lowercase SHA-256 version id, as returned by version_create."
  2. First observedv0.1.7

TDQS

A4.7/5.0
Behavior5/5

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

Annotations already declare readOnly/idempotent/non-destructive, yet the description still adds real value: digest verification happens before diffing, the exact return shape {parent, child, changed, diff} is disclosed despite no output schema, and binary files are named rather than diffed. These are behaviors an agent cannot infer from annotations.

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?

Three compact sentences: what it does, when to use it versus the sibling, then behavior and return shape. Nothing is redundant and the operation is front-loaded.

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

Completeness5/5

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

For a 3-required-parameter read tool with no output schema, the description covers purpose, alternative routing, verification behavior, return keys, and the binary-file edge case. An agent has everything needed to call it correctly and interpret the result.

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 100% and each parameter carries a detailed description (SHA-256 ids from version_create, config path semantics, --config rejection). The description adds only the pairing notion of parent/child snapshots, which the schema largely already conveys, so the baseline of 3 applies.

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

Purpose5/5

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

States a specific verb and resource ('Show the unified text diff of editable files between two stored versions') plus a distinguishing condition ('after verifying both snapshots' content digests'). It explicitly separates itself from compare_paired, so an agent can choose without opening either schema.

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

Usage Guidelines5/5

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

Gives an explicit use case ('review a candidate before proposing or gating') and names the alternative with the condition that selects it ('use compare_paired to compare measured outcomes instead'). When-to-use and when-not-to-use are both covered.

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