Skip to main content
Glama
specshield26

SpecShield MCP Server

Explain the breaking changes

explain_breaking_changes
Read-only

Analyzes API spec changes to identify breaking changes, detail developer and consumer impact, and suggest migration steps.

Instructions

Explains what breaks in an API spec change and why, with developer impact, likely consumer impact, and suggested migration steps. Analyzes API contract compatibility only; it does NOT modify code.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
baseSpecPathNoPath to the base (old) spec file.
targetSpecPathNoPath to the target (new) spec file.
baseSpecContentNoInline base (old) spec content.
targetSpecContentNoInline target (new) spec content.
Behavior4/5

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

Annotations already indicate readOnlyHint and non-destructive. The description adds that the tool analyzes compatibility only and returns impact and migration steps, providing useful context beyond annotations.

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?

Two sentences, front-loaded with purpose, no wasted words. Concisely conveys what the tool does and its constraints.

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

Completeness4/5

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

Given no output schema, the description explains return content (developer impact, consumer impact, migration steps). It could mention input constraints like required parameter combinations, but overall adequate.

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 coverage is 100% and each parameter has a clear description. The description does not add additional meaning beyond what the schema provides, so baseline score of 3 is appropriate.

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?

The description clearly states the tool's function: 'Explains what breaks in an API spec change and why' and lists specific outputs. It also distinguishes from siblings by noting it does not modify code.

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

Usage Guidelines4/5

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

The description implies usage for analyzing API contract compatibility and explicitly states it does not modify code, but lacks explicit guidance on when to choose this over siblings like compare_specs or generate_migration_guide.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/specshield26/specshield-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server