Skip to main content
Glama

BRAINIAC API Integration Intelligence

Compare API contracts

integration_contract-compare

List schema changes. A change is labeled breaking or non-breaking only when side is request or response. Title and description are ignored. Price $0.05 USDC. POST /api/v1/integration/contract-compare. Unpaid calls return 402 and do not run.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "integration_contract-compare"
  }
}

Input Schema

NameRequiredDescriptionDefault
fileNo
jsonNo
sideNo
afterNo
beforeNo
schemaNo
sourceNo
targetNo
exampleNo
payloadNo
examplesNo
toVersionNo
operationsNo
fromVersionNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

B3.1/5.0
Behavior3/5

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

With no annotations, the description carries the full burden, and it does disclose genuinely useful behavior: a $0.05 USDC price, a POST endpoint, and that unpaid calls return 402 and do not execute. It also explains the breaking/non-breaking labeling rule and that title/description fields are ignored. What it omits is the response shape and whether the operation has any side effects, which matters for a paid POST.

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?

Five short sentences, front-loaded with the core action, then the labeling rule, then cost and payment behavior. Nothing is padded, though the telegraphic fragments trade some readability for density.

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?

For a 14-parameter tool with nested objects, zero schema description coverage, and no output schema, the description is far too thin. An agent cannot tell from it which of the many input shapes to supply, what the diff output contains, or how the operations array affects the comparison.

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

Parameters4/5

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

Schema description coverage is 0% across 14 parameters, so the description must compensate and largely does not — before/after, source/target, schema, file, json, operations, and the version fields are all unexplained. The one exception is the side parameter, whose enum meaning (request or response) is clarified as the gate for breaking-change labeling, which is real added meaning beyond the bare enum.

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

Purpose3/5

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

"List schema changes" names a resource and an implied diff operation, and the title adds "Compare API contracts," so the general intent is graspable. But the description never states what is being compared (before/after schemas, versions, source/target) and does not distinguish it from siblings like integration_version-compatibility-check or integration_json-schema-validate.

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 when-to-use guidance at all: no statement of which parameter combination to pick (before/after vs. schema/source/target vs. file/json), no prerequisites, and no routing to or away from the sibling compatibility and validation tools. The only conditional content is a labeling rule, 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