Skip to main content
Glama

versions: GET /api/versions/compare/:id1/:id2

get_versions_compare_by_id1_by_id2_a3047b60a11595774cbf33ba
Read-onlyIdempotent

GET /api/versions/compare/:id1/:id2. GET /api/versions/compare/:id1/:id2. Operation ID: a3047b60a11595774cbf33ba; describe_operation provides native request schemas.

Input Schema

NameRequiredDescriptionDefault
queryNo
paramsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

D1.6/5.0
Behavior2/5

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

Annotations already declare readOnlyHint=true, idempotentHint=true, destructiveHint=false and openWorldHint=false, so the safety profile is covered elsewhere. The description adds only the pointer that describe_operation provides native request schemas; it says nothing about what a comparison yields (diff structure, missing-ID behavior, response shape).

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

Conciseness2/5

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

It is short, but the same route string is duplicated verbatim, wasting the only two sentences available. The useful hint about describe_operation is buried after the repetition rather than front-loaded.

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

Completeness1/5

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

For a nested-object, two-param comparison endpoint with no output schema and no annotation-level detail about results, the description is essentially empty. An agent cannot determine what a comparison returns or how the IDs relate without falling back to describe_operation.

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

Parameters1/5

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

Schema description coverage is 0% for the two required params id1 and id2. The description merely echoes the path placeholders without clarifying what each ID refers to (version IDs? entity IDs?) or how ordering affects the comparison, so it fails to compensate for the coverage gap.

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

Purpose2/5

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

The description contains only the raw route 'GET /api/versions/compare/:id1/:id2' repeated twice, which restates the name/title rather than explaining what comparing two versions actually returns or accomplishes. An agent can infer a comparative read of two version IDs, but there is no stated resource semantics or differentiation from siblings like get_versions_by_id or get_versions.

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

Usage Guidelines1/5

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

There is no when-to-use guidance, no prerequisites, and no mention of alternatives such as get_versions_by_id for single-version retrieval. The only pointer is to describe_operation for schemas, which is not usage guidance.

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