Skip to main content
Glama
Sign In
@mhdd_24/api-versioning-mcp

@mhdd_24/api-versioning-mcp

by Mhdd-24
OverviewSchemaSourceRelated ServersDiscussionsAdmin
TypeScript
Local

apiver_compare

Compare two versioned API path lists to detect added, removed, and changed endpoints, helping identify breaking changes and plan versioning strategy.

Instructions

Compare two versioned API path lists.

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": {
      "v1": "<v1>",
      "v2": "<v2>"
    },
    "name": "apiver_compare"
  }
}

Input Schema

NameRequiredDescriptionDefault
v1YesVersion A paths
v2YesVersion B paths

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.0.0

TDQS

C2.9/5.0
Behavior2/5

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

With no annotations, the description carries the full burden of behavioral disclosure, yet it says nothing about whether the operation is read-only, what the comparison produces, or how differences are reported. "Compare" is too thin to convey the behavioral profile of a mutation-free analysis tool.

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 zero wasted words. It is appropriately sized, though its brevity reflects under-specification rather than tight editing.

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

Completeness2/5

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

There is no output schema and no annotations, so the description should explain what the comparison returns and in what shape. For a tool whose entire value is the comparison result, leaving the return semantics unspecified is a meaningful gap.

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 v1 and v2 documented as "Version A paths" and "Version B paths", so the schema already does the heavy lifting. The description adds no format details (e.g., newline-delimited paths) beyond what the schema provides, making baseline 3 appropriate.

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?

The description states a specific verb ("Compare") and resource ("two versioned API path lists"), which is clearly distinct from apiver_status and apiver_strategy. It is clear but does not explain the nature of the comparison or how it differs in scope from the sibling tools.

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?

There is no guidance on when to use this tool versus apiver_status or apiver_strategy, and no preconditions or exclusions are stated. The agent must infer usage entirely from the name.

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