Skip to main content
Glama

compare_versions

Read-onlyIdempotent

Compare two recorded versions of a configuration resource to inspect changes between them, helping identify what differs across versions.

Instructions

Compare two recorded versions of a configuration resource and inspect their changes.

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": {
      "resource_type": "<resource_type>",
      "resource_id": "<resource_id>",
      "from_version": "<from_version>",
      "to_version": "<to_version>"
    },
    "name": "compare_versions"
  }
}

Input Schema

NameRequiredDescriptionDefault
to_versionYesTarget version, normally the newer version
resource_idYesResource UUID
from_versionYesSource version, normally the older version
resource_typeYesResource type

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed4 schema fields changedv2.2.4
    • changedInput schema / properties / from_version / description
      Previous value: -"Versão de origem (mais antiga)"New value: +"Source version, normally the older version"
    • changedInput schema / properties / resource_id / description
      Previous value: -"UUID do recurso"New value: +"Resource UUID"
    • changedInput schema / properties / resource_type / description
      Previous value: -"Tipo do recurso"New value: +"Resource type"
    • changedInput schema / properties / to_version / description
      Previous value: -"Versão de destino (mais recente)"New value: +"Target version, normally the newer version"
  2. First observedv0.1.0

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare this a read-only, idempotent, non-destructive, closed-world operation, so the safety profile is covered. The description adds a small amount of context by framing the purpose as inspecting changes, but says nothing about behavior when a version is missing, out-of-order versions, or the shape of the comparison result.

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?

A single front-loaded sentence with no filler and no redundant restatement of the name. It is appropriately sized, though it could have used one extra clause to carry real guidance.

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?

With no output schema, the description should describe what a comparison yields, but 'inspect their changes' leaves the return format undefined. Errors (nonexistent or identical versions) and how to obtain valid version numbers are also unaddressed, making it only minimally complete for a diff-style operation.

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% with all four parameters documented, including enum values for resource_type and directional hints for from_version/to_version. The description adds no parameter-level meaning beyond that, so the baseline of 3 applies.

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?

Specific verb ('Compare') plus a specific resource ('two recorded versions of a configuration resource'), and it adds the outcome goal ('inspect their changes'). It does not explicitly distinguish itself from version-related siblings such as list_versions, 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 Guidelines2/5

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

The description states what the tool does but gives no when-to-use guidance, no prerequisite that both versions must already exist, and no pointer to how to discover valid version numbers (e.g., via list_versions). Usage is only inferable from the verb.

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

Deploy Server

Other Tools