Skip to main content
Glama

Compare Versions

compare_versions
Read-only

Compare two specification versions and show their differences: added/removed/modified endpoints and schemas. Omit sourceVersionId to compare against the latest published version. detail 'full' (default) returns the changed entities; 'flags' returns only what changed and how — much smaller, and enough to decide where to look. Requires project context.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
detailNoHow much to return: 'full' (default) or 'flags'full
specIdYesPublic ID (GUID) of the API specification
sourceVersionIdNoPublic ID (GUID) of the source (older) version — omit for the latest published version
targetVersionIdYesPublic ID (GUID) of the target (newer) version

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. First observed

TDQS

A4.8/5.0
Behavior4/5

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

Annotations already declare readOnlyHint=true, so no destructive action is implied. The description adds the contextual requirement ('Requires project context') but does not mention rate limits or auth, which is acceptable given the read-only hint. No contradictions.

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?

The description is concise (three sentences) and well-structured, starting with the primary purpose, then the key optional behavior, then the parameter nuance. No redundant information.

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?

No output schema is provided, but the description explains what to expect in both detail modes ('changed entities' vs 'what changed and how'). It also mentions the prerequisite of project context, making the invocation conditions clear.

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

Parameters5/5

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

All parameters have schema descriptions (100% coverage), and the tool description adds crucial semantics: omitting sourceVersionId uses the latest published version, and the 'detail' parameter's two values ('full' vs 'flags') are explained with their output differences. This goes beyond the schema.

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?

Clearly states the action ('Compare two specification versions') and the result ('show their differences: added/removed/modified endpoints and schemas'). Distinct from sibling tools as no other tool explicitly compares versions.

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?

Provides explicit usage guidance: 'Omit sourceVersionId to compare against the latest published version' and explains the 'detail' parameter options with their use cases ('flags' is smaller and enough to decide where to look). Also notes the prerequisite 'Requires project context.'

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.

TDQS

A3.9/5.0
Disambiguation4/5

The tools are mostly distinct with clear descriptions. Some pairs like get_header_policies vs get_resolved_headers or get_environment_verification vs get_monitoring_sync_status could be slightly confusing, but the descriptions clarify scope and purpose.

Naming Consistency5/5

All tools follow a consistent snake_case verb_noun pattern (get_, list_, create_, update_, manage_, etc.). Even the few bare verbs like 'search' and 'set_context' are consistent with the naming scheme.

Tool Count1/5

With 165 tools, the server is extremely heavy. This far exceeds the 'too many' threshold of 25+, making it difficult for an agent to navigate and select the right tool efficiently.

Completeness5/5

The tool surface covers a very broad API lifecycle domain: specs, environments, test cases, monitors, mock servers, security, governance, documentation, and team management. Read and write operations are present across most areas, with no obvious missing core functionality.

Resources