What it does
Which services an API change breaks and why: OpenAPI, GraphQL, gRPC, AsyncAPI, SOAP.
- Connects Runs on your computer
- Account or key No key needed
- Category Developer tools
Use together with
Skills that teach the AI this kind of work; they work alongside this one
andrej-karpathy-skills
A single CLAUDE.md file to improve Claude Code behavior, derived from Andrej Karpathy's observations on LLM coding pitfalls.
Why it ranks here
Lists are ordered by a usage score (out of 100) built from these parts
| Popularity | 0/80 | GitHub stars or weekly downloads: the larger counts 60, the smaller 20 |
|---|---|---|
| Freshness | 12/12 | Full marks for a release or code change within 30 days |
| Still answering | 0/8 | The cloud endpoint answered at the last check |
| Usage score | 12/100 |
Quality: Passed 3/3 basic checks (shown, not used for ordering) · Momentum: No data yet (Used only on the Trending tab)
Install
Pick the AI app you use, then copy the settings.
Let your AI install it with one sentence
Please install k11 API Contract QA. Follow https://mcp.popnx.com/i/k11-software-solutions-api-contract-qa.md, show me the commands and wait for my OK before running them.Paste it into an AI that can work on your computer (such as Claude Code or Cursor). It reads our steps, shows you the commands and waits for your OK. No key, no sign-up. · See the full text your AI reads
Passed 3/3 checks · Runs on your computer · ✓ Commands checked Nov 14, 2026
First: which AI do you use?
Pick your app and the steps appear below.
Works with Claude, with some setup first
Install Python (uv) on your computer first (one time) · Only the Claude desktop app (Windows or Mac), not the web or phone
Let AI install it
Copy this message into a Claude chat. The AI checks your computer, tells you which file it will change, and waits for your OK every time.
Please install the MCP server k11 API Contract QA for Claude on this computer, in this order: 1) Check uv with uv --version. If it is missing, tell me to install it from https://docs.astral.sh/uv/getting-started/installation/; do not install it yourself. 2) Use only this config (already checked by PopNx MCP): { "mcpServers": { "api-contract-qa": { "command": "uvx", "args": [ "k11-api-contract-qa-mcp" ] } } } 3) Tell me the full path of the file you will change, or the command you will run, and wait for my OK. 4) No key is needed. 5) Do what we agreed, then check that the k11 API Contract QA tools really show up.This message has no key in it. If a key is needed, the AI will ask you to paste it yourself into the file or the app’s field.
Install uv (if you don’t have it)
Already installed? Check first · Open Terminal, type this command and press Enter
uv --version- A version number such as uv … = installed, skip this step
- "command not found" (on Windows: "is not recognized") = not installed yet, or installed but Terminal needs to be closed and reopened
How to open Terminal
Mac: press ⌘ + Space, type Terminal, press Enter
Windows: open Start, type Windows PowerShell, then Open
Not installed: uv has no click-through installer. Copy the one-line command for your system (macOS or Windows) from uv’s official page into Terminal · no separate Python install needed; uv downloads it when required
When it’s done, close Terminal, open it again and run the same command. You should see a version number:
uv --versionInstall once; it works for everything that needs uv
Open the Claude desktop app’s settings file
SettingsDeveloperEdit Config
Paste these settings and save the file
{ "mcpServers": { "api-contract-qa": { "command": "uvx", "args": [ "k11-api-contract-qa-mcp" ] } } }Quit Claude and open it again
Try it
Use k11 API Contract QA and tell me what you can do for me, then show me one thing✓ If Claude says it is using k11 API Contract QA or shows a k11 API Contract QA tool in the answer, you are connected
1 optional setting(s) (works without them)
The command above works without these. Add them only if you want to change something, following the maker’s description.
QA_MCP_ROOTFolder of the service or repo with the spec (default: current directory)
Descriptions are as written by the maker.
Menu names checked against Anthropic’s help page on Nov 11, 2026 · your screen may differ slightly by app version
ChatGPT cannot connect k11 API Contract QA yet
k11 API Contract QA runs on your computer, but ChatGPT can only connect servers that run on the web
What you can do instead
A · Use an app that can connect k11 API Contract QA
- Install Python (uv) on your computer first (one time) · Only the Claude desktop app (Windows or Mac), not the web or phone
- Install Python (uv) on your computer first (one time)
- Install Python (uv) on your computer first (one time)
- Install Python (uv) on your computer first (one time)
B · Others in Developer tools that work with ChatGPT
Picked from the most used in the same category, only ones that connect by address with no key
- Sentry✓ ChatGPT
- Compiler Explorer✓ ChatGPT
- GitDiagram✓ ChatGPT
Works with Claude Code, with some setup first
Install Python (uv) on your computer first (one time)
Let AI install it
Copy this message into a Claude Code chat. The AI checks your computer, tells you which file it will change, and waits for your OK every time.
Please install the MCP server k11 API Contract QA for Claude Code on this computer, in this order: 1) Check uv with uv --version. If it is missing, tell me to install it from https://docs.astral.sh/uv/getting-started/installation/; do not install it yourself. 2) Use only this config (already checked by PopNx MCP): claude mcp add --scope user api-contract-qa -- uvx k11-api-contract-qa-mcp 3) Tell me the full path of the file you will change, or the command you will run, and wait for my OK. 4) No key is needed. 5) Do what we agreed, then check that the k11 API Contract QA tools really show up.This message has no key in it. If a key is needed, the AI will ask you to paste it yourself into the file or the app’s field.
Install uv (if you don’t have it)
Already installed? Check first · Open Terminal, type this command and press Enter
uv --version- A version number such as uv … = installed, skip this step
- "command not found" (on Windows: "is not recognized") = not installed yet, or installed but Terminal needs to be closed and reopened
How to open Terminal
Mac: press ⌘ + Space, type Terminal, press Enter
Windows: open Start, type Windows PowerShell, then Open
Not installed: uv has no click-through installer. Copy the one-line command for your system (macOS or Windows) from uv’s official page into Terminal · no separate Python install needed; uv downloads it when required
When it’s done, close Terminal, open it again and run the same command. You should see a version number:
uv --versionInstall once; it works for everything that needs uv
Open Terminal
Mac: press Command+Space and type Terminal · Windows: open PowerShell
Paste this command and press Enter
claude mcp add --scope user api-contract-qa -- uvx k11-api-contract-qa-mcpType /mcp in Claude Code
You should see k11 API Contract QA listed as connected
Try it
Use k11 API Contract QA and tell me what you can do for me, then show me one thing✓ If Claude Code says it is using k11 API Contract QA or shows a k11 API Contract QA tool in the answer, you are connected
1 optional setting(s) (works without them)
The command above works without these. Add them only if you want to change something, following the maker’s description.
QA_MCP_ROOTFolder of the service or repo with the spec (default: current directory)
Descriptions are as written by the maker.
Menu names checked against Anthropic’s help page on Nov 11, 2026 · your screen may differ slightly by app version
Works with Cursor, with some setup first
Install Python (uv) on your computer first (one time)
Let AI install it
Copy this message into a Cursor chat. The AI checks your computer, tells you which file it will change, and waits for your OK every time.
Please install the MCP server k11 API Contract QA for Cursor on this computer, in this order: 1) Check uv with uv --version. If it is missing, tell me to install it from https://docs.astral.sh/uv/getting-started/installation/; do not install it yourself. 2) Use only this config (already checked by PopNx MCP): { "mcpServers": { "api-contract-qa": { "command": "uvx", "args": [ "k11-api-contract-qa-mcp" ] } } } 3) Tell me the full path of the file you will change, or the command you will run, and wait for my OK. 4) No key is needed. 5) Do what we agreed, then check that the k11 API Contract QA tools really show up.This message has no key in it. If a key is needed, the AI will ask you to paste it yourself into the file or the app’s field.
Install uv (if you don’t have it)
Already installed? Check first · Open Terminal, type this command and press Enter
uv --version- A version number such as uv … = installed, skip this step
- "command not found" (on Windows: "is not recognized") = not installed yet, or installed but Terminal needs to be closed and reopened
How to open Terminal
Mac: press ⌘ + Space, type Terminal, press Enter
Windows: open Start, type Windows PowerShell, then Open
Not installed: uv has no click-through installer. Copy the one-line command for your system (macOS or Windows) from uv’s official page into Terminal · no separate Python install needed; uv downloads it when required
When it’s done, close Terminal, open it again and run the same command. You should see a version number:
uv --versionInstall once; it works for everything that needs uv
Open the AI chat in Cursor in Agent mode
Try it
Use k11 API Contract QA and tell me what you can do for me, then show me one thing✓ If Cursor says it is using k11 API Contract QA or shows a k11 API Contract QA tool in the answer, you are connected
1 optional setting(s) (works without them)
The command above works without these. Add them only if you want to change something, following the maker’s description.
QA_MCP_ROOTFolder of the service or repo with the spec (default: current directory)
Descriptions are as written by the maker.
Menu names checked against Cursor’s help page on Nov 11, 2026 · your screen may differ slightly by app version
Works with VS Code, with some setup first
Install Python (uv) on your computer first (one time)
Let AI install it
Copy this message into a VS Code chat. The AI checks your computer, tells you which file it will change, and waits for your OK every time.
Please install the MCP server k11 API Contract QA for VS Code on this computer, in this order: 1) Check uv with uv --version. If it is missing, tell me to install it from https://docs.astral.sh/uv/getting-started/installation/; do not install it yourself. 2) Use only this config (already checked by PopNx MCP): { "servers": { "api-contract-qa": { "type": "stdio", "command": "uvx", "args": [ "k11-api-contract-qa-mcp" ] } } } 3) Tell me the full path of the file you will change, or the command you will run, and wait for my OK. 4) No key is needed. 5) Do what we agreed, then check that the k11 API Contract QA tools really show up.This message has no key in it. If a key is needed, the AI will ask you to paste it yourself into the file or the app’s field.
Install uv (if you don’t have it)
Already installed? Check first · Open Terminal, type this command and press Enter
uv --version- A version number such as uv … = installed, skip this step
- "command not found" (on Windows: "is not recognized") = not installed yet, or installed but Terminal needs to be closed and reopened
How to open Terminal
Mac: press ⌘ + Space, type Terminal, press Enter
Windows: open Start, type Windows PowerShell, then Open
Not installed: uv has no click-through installer. Copy the one-line command for your system (macOS or Windows) from uv’s official page into Terminal · no separate Python install needed; uv downloads it when required
When it’s done, close Terminal, open it again and run the same command. You should see a version number:
uv --versionInstall once; it works for everything that needs uv
Open the AI chat in VS Code in Agent mode
Try it
Use k11 API Contract QA and tell me what you can do for me, then show me one thing✓ If VS Code says it is using k11 API Contract QA or shows a k11 API Contract QA tool in the answer, you are connected
1 optional setting(s) (works without them)
The command above works without these. Add them only if you want to change something, following the maker’s description.
QA_MCP_ROOTFolder of the service or repo with the spec (default: current directory)
Descriptions are as written by the maker.
Menu names checked against VS Code’s help page on Nov 11, 2026 · your screen may differ slightly by app version
For developers: Terminal commands and JSON settings
Installed on your computer
Claude Code
claude mcp add --scope user api-contract-qa -- uvx k11-api-contract-qa-mcpClaude Desktop (claude_desktop_config.json)
{
"mcpServers": {
"api-contract-qa": {
"command": "uvx",
"args": [
"k11-api-contract-qa-mcp"
]
}
}
}Cursor (~/.cursor/mcp.json)
{
"mcpServers": {
"api-contract-qa": {
"command": "uvx",
"args": [
"k11-api-contract-qa-mcp"
]
}
}
}VS Code (mcp.json)
{
"servers": {
"api-contract-qa": {
"type": "stdio",
"command": "uvx",
"args": [
"k11-api-contract-qa-mcp"
]
}
}
}Values you fill in
QA_MCP_ROOTenvFolder of the service or repo with the spec (default: current directory)
Descriptions are as written by the maker.
These settings are generated from the maker’s registry entry. If the README says otherwise, follow the README.
At a glance
- Downloads per weeki
- Not on npm/PyPI
- Connection
- Runs on your computer
- Latest versioni
- 0.1.0
- Categoryi
- Developer tools
- Published to registryi
- Nov 13, 2026
- Code last changedi
- Nov 16, 2026
- Maker
- K11-Software-Solutions
- Packages
pypi: k11-api-contract-qa-mcp- Website
- github.com
- Registry status
- Active
Which apps can use it
Based on how this server connects and on each app’s own docs, checked Nov 10, 2026.
Run on your computer in
ClaudeGooseLM StudioMsty StudioCherry StudioCursorVS Code + GitHub CopilotVisual StudioWindsurf (Devin Desktop)ZedKiroClineContinueJetBrains AI AssistantClaude CodeCodex CLIGemini CLIOpenCodenodecodeWarpLibreChatRaycast
Related guides
What it can do
Runs on your computer; the tool list appears in your AI app after you install it.
Basic checksi
We check information anyone can see; we have not read the code. Checks that do not apply are left out of the count. · Checked Nov 19, 2026
- ✓ Pass
Maker matches the repo
The registry name was verified with the GitHub account K11-Software-Solutions, which owns the repo
- ✓ Pass
Still maintained
Code last changed 3 days ago
- ✓ Pass
Has a licence
Uses MIT
- – Not applicable
Endpoint responds
This one runs on your computer; there is no internet endpoint
- – Not applicable
Sign-in with OAuth
Runs on your computer and uses local settings instead
- … Not checked yet
No hidden instructions in tool descriptions
Runs on your computer; we can only read tool lists from internet endpoints
Published vulnerabilities (OSV.dev)
No entries on OSV.dev for k11-api-contract-qa-mcp@0.1.0
Checks only this package version, not every dependency · checked Nov 16, 2026
Makers: ask for a re-check or report wrong info
For makers: add a badge to your README
If you made this, paste this code into your README. The badge links back to this page.
[](https://mcp.popnx.com/en/servers/k11-software-solutions-api-contract-qa)Discussion
Ask, share a tip or report that it does not work. Sorted by what people marked helpful.
No posts yet. Be the first to ask or share.
Posts here are written by users, not the PopNx team.
User reviews
No reviews yet
Compared with others in Developer toolsi
- More stars than 0% of the other 6116 servers in this category
- Published to the registry more recently than 88% of the other 6116 servers in this category
- Basic checks equal to or better than 99% of the other 6116 servers in this category
Compared with every active server in this category in the registry. Stars count only when the publisher owns the repo.
Common questions
Is k11 API Contract QA safe?
It passed 3 of 3 applicable basic checks. We have not read the code. Before adding a key or token, see what access the server asks for and use a key with only the permissions you need.
What keys or codes does it need?
The registry does not list a required key, though some servers ask you to sign in on first use.
Does it run on my computer or in the cloud?
It runs on your computer. Your AI app starts it when needed, and data does not pass through the maker’s servers (unless it calls an online service itself).
Is it still maintained?
The GitHub repo last changed 3 days ago, and the latest version (0.1.0) reached the registry 6 days ago.
Which apps can use it?
Apps that support MCP, such as Claude Desktop, Claude Code, Cursor and VS Code. You also need Python (uv) on your computer.
What can I use instead?
In the same category: GitDiagram, Appllama, Cloudflare MCP, Omnara, Repowise
Similar alternatives
Same category, other makers, commands already checked. Official ones first, then by stars.
Reading a card:↓ Downloads per weeki★ GitHub starsiThree pillars: reviews · checks · usageiUpdated = latest version published to the registryi
GitDiagram
Architecture diagrams, explanations and Mermaid source for public GitHub repositories.
Appllama
Study screens, flows and paywalls from top-earning iOS apps, then build from what wins.
Cloudflare MCP
Cloudflare MCP servers
Omnara
Deploy durable AI agents with Omnara, an open-source managed-agent platform.
Repowise
Codebase intelligence for AI coding agents: graph, git history, docs, decisions, code health.
| This one k11 API Contract QA | GitDiagram | Appllama | Cloudflare MCP | Omnara | Repowise | |
|---|---|---|---|---|---|---|
| Runs where | Installs on your computer | Runs in the cloud, nothing to install | Runs in the cloud, nothing to install | Runs in the cloud, nothing to install | Runs in the cloud, nothing to install | Cloud or install on your computer |
| Needs a key | No | No | No | No | No | No |
| Add with + in Claude | No | No | No | Yes | No | No |
| Basic checks | 3/3 | 4/4 | 4/4 | 4/4 | 4/4 | 5/5 |
| License | MIT | MIT | MIT | Apache-2.0 | Apache-2.0 | AGPL-3.0 |
| Price | No cost listed in the registry | No cost listed in the registry | No cost listed in the registry | No cost listed in the registry | No cost listed in the registry | No cost listed in the registry |
README from the maker
Open the README
Copied from the maker’s repo as written. PopNx MCP has not reviewed or endorsed it. HTML, images and scripts are removed. Links lead off this site.
k11 API Contract QA — MCP server & Claude Code plugin
Know which services an API change breaks before you merge it, and why. REST, GraphQL, gRPC, events and SOAP.
A pull request renames a field or tightens a request body. Its own tests pass. Three other services break in production. Spec-diff tools can tell you a change is "breaking", but not *who* it breaks, so teams either ignore the warnings or block every change. This MCP server answers the real question:
- Breaking-change detection for OpenAPI 3.x, Swagger 2.0, GraphQL, gRPC/protobuf, AsyncAPI 2.x/3.x and SOAP/WSDL 1.1, including
$refs, nested fields and array items, with the rule each change broke. - Consumer-aware impact. It knows which services call which endpoints, and which fields they read or send. A removed field only counts against the consumers that use it.
- A verdict with evidence: breaking, breaking but no known consumer uses it, or compatible. When 2 or more consumers break, or a critical one does, it says a person should decide before merge.
- Deployed-contract drift: compares what a running service publishes (GraphQL introspection,
?wsdl,/v3/api-docs) with your spec file. - Live conformance checks for REST: status codes, content type and the JSON body validated against the schema.
- Consumer discovery that scans a consumer's source code (Python, Java, TypeScript, Go, …) for calls to your API, with file and line. For GraphQL it parses the consumer's actual queries, so it knows exactly which fields they read.
- Contract test generation for pytest + httpx or Java REST Assured.
- `contract-ci`: a pull-request comment that lists every affected consumer and the reason.
Deterministic rules, no LLM calls, the same result every run. Works with Claude Code (as a plugin with /check-api-change and /api-contract-tests), Claude Desktop and any MCP client. Listed in the official MCP Registry as io.github.K11-Software-Solutions/api-contract-qa.
See it in a pull request
In the demo, Order Service v2 changes total from a number to a string, drops customer.email, adds a required channel to POST /orders and removes DELETE /orders/{id}. Four services consume it. contract-ci posted:
## API contract check: 🔴 Breaking for known consumers
Order Service:
main→ this PR. 11 changes, 6 breaking (worst: critical); 4 known consumers, 3 affected.
> Needs a person before merge: 3 consumers break (threshold 2); high-criticality consumers break: notification-svc, billing-svc, checkout-web.
| Consumer | Owner | Criticality | Breaking change | Why it affects them |
|---|---|---|---|---|
| billing-svc | @team-billing | critical |
GET /orders/{id}: Response field 'total' changed type from number to string | reads 'total' |
| checkout-web | @team-web | high |
POST /orders: New required request field 'channel' | doesn't send the now-required 'channel' |
| notification-svc | @team-notify | high |
GET /orders/{id}: Response field 'customer.email' was removed | reads 'customer.email' |
Breaking, no known consumer:
DELETE /orders/{orderId}was removed, plus two response changes onPOST /ordersthat checkout-web doesn't read.
analytics-svc calls GET /orders too, but it reads only id and status, so it isn't flagged.
Supported contracts
The format is detected automatically from the file. Every format goes through the same rules, consumer impact, report and contract-ci, plus rules specific to it.
| Format | Operations are named | Format-specific rules | Deployed drift check |
|---|---|---|---|
| OpenAPI 3.x | GET /orders/{id} | parameters, request bodies, success responses, auth | GET the published document |
| Swagger 2.0 | GET /api/orders/{id} | converted to OpenAPI 3 on load (body/formData, definitions, basePath) | GET the published document |
| GraphQL (SDL or introspection JSON) | QUERY order, MUTATION createOrder | removing *any* argument breaks (unknown arguments are errors); non-null → nullable breaks readers | introspection query |
gRPC / protobuf (.proto, imports followed) | RPC shop.v1.OrderService/GetOrder | field number changed or reused, field renamed (wire-safe but breaks JSON and generated code), removed numbers not reserved, streaming changed, message replaced | not yet (needs server reflection) |
| AsyncAPI 2.x / 3.x | EMITS order.created, RECEIVES order.cancel | emitted messages follow reader rules; received messages follow writer rules | GET the published document |
| SOAP / WSDL 1.1 | SOAP OrderPort/GetOrder | XSD minOccurs/maxOccurs/nillable, enumerations, extension; SOAPAction and binding style; strict about unknown elements | GET ...?wsdl |
Consumer discovery finds HTTP paths, GraphQL query documents (exact fields read), gRPC stub calls, SOAP client calls (zeep, JAX-WS, .NET) and AsyncAPI topic names. Live response checks and test generation are for REST (OpenAPI and Swagger).
Tools
| Tool | What it does |
|---|---|
list_operations | Lists a contract's operations and its detected format. |
diff_contracts | Classifies every change between two versions of a contract: rule, field path, before/after, severity. |
assess_impact | Which consumers a change breaks and why; the verdict and whether a person should decide. Optionally writes the report. |
discover_consumer_usage | Finds a consumer's calls to your API in its source code and drafts its consumers.yaml entry. |
check_deployed_contract | Compares what a running service publishes with the spec: matches, drift or incompatible. |
check_live_conformance | Calls a running REST endpoint and checks the response against the spec. Header values can use ${ENV:NAME}. |
generate_api_tests | REST contract tests (status + JSON schema) for pytest + httpx or REST Assured. |
write_test | Writes generated files under tests/ or src/test/ only, never overwriting unless asked. |
Specs are files in the project or git refs: origin/main:openapi.yaml, origin/main:proto/orders.proto (imports are read from the same ref).
Tell it who your consumers are
.qa-mcp/consumers.yaml:
consumers:
- name: billing-svc repo: acme/billing-svc owner: "@team-billing" criticality: critical # critical | high | medium | low uses:
- endpoint: GET /orders/{id} reads: [id, total, currency] # leave out to mean "any field"
- name: checkout-web owner: "@team-web" criticality: high uses:
- endpoint: POST /orders sends: [customerId, items] reads: [id]
Endpoints use the operation names from the table above (QUERY order, RPC shop.v1.OrderService/GetOrder, EMITS order.created, …). Field lists are what make the verdict precise. Without them, any breaking change on an endpoint counts against everyone who calls it. Start with discover_consumer_usage on each consumer's code, then add the fields.
In CI
k11-api-contract-qa-mcp contract-ci --spec openapi.yaml --base origin/main
It compares the spec in the pull request with origin/main, writes contract-report.md (the PR comment) and contract-report.json, sets GitHub Actions outputs (verdict, breaking, consumers_affected, needs_human, report) and exits non-zero according to --fail-on:
--fail-on | Fails when |
|---|---|
breaking (default) | a known consumer breaks |
needs-human | 2+ consumers or a critical/high one break |
any-breaking | any breaking change, used or not |
never | report only |
Copy docs/contract-check.yml to .github/workflows/ to comment on every pull request that touches the spec.
Install
Requires Python 3.10+.
Claude Code: plugin (recommended)
Needs uv:
/plugin marketplace add K11-Software-Solutions/k11techlab-api-contract-qa-mcp
/plugin install api-contract-qa@k11-api-contract-qa
Claude Code: MCP server only
claude mcp add api-contract-qa -- uvx k11-api-contract-qa-mcp
Claude Desktop and other MCP clients
{
"mcpServers": { "api-contract-qa": { "command": "uvx", "args": ["k11-api-contract-qa-mcp"], "env": { "QA_MCP_ROOT": "/path/to/your/service" } } } }
Or pip install k11-api-contract-qa-mcp.
Try the demo
cd demo/order-service
k11-api-contract-qa-mcp contract-ci --spec openapi.yaml --base-spec openapi.v1.yaml python server.py --port 8080 # v2 implementation with one deliberate contract bug
Then ask Claude to check_live_conformance on GET /orders/{id} with id 1001. It finds that total is still sent as a number.
demo/formats/ has a v1 and v2 contract for each other format (Swagger 2.0, GraphQL, protobuf with an import, AsyncAPI 2.x → 3.x, WSDL) and a small consumer for each, for example:
k11-api-contract-qa-mcp contract-ci --spec demo/formats/graphql/schema.graphql --base-spec demo/formats/graphql/schema.v1.graphql --fail-on never
Rules
These apply to every format (with each format's names for inputs and outputs):
| Rule | Breaking? |
|---|---|
| Endpoint removed | yes (critical) |
| Response field removed, type changed, became nullable, no longer guaranteed | yes |
| Success response or JSON media type removed | yes |
| New required request field / parameter, field or parameter became required | yes |
| Request enum value removed, request field newly restricted to an enum | yes |
| New authentication requirement | yes (critical) |
| Required request field removed (any removed input for GraphQL and SOAP) | yes |
| New endpoint, optional field or parameter; response enum value added | no (enum additions flagged for exhaustive switches) |
| Path parameter renamed, endpoint deprecated | no |
| protobuf: field number changed, message replaced, streaming changed | yes |
| protobuf: field renamed with the same number | yes (medium: wire-safe, breaks JSON and generated code) |
The rules extend the K11 research on cross-repository contract testing and change impact analysis (IJECS, 2026), whose reference system is k11techlab-microservice-qa-system. This server adds $ref, nested and array-item rules, field-level consumer matching and five more contract formats.
Attribution and licensing. k11 API Contract QA is a new, independent implementation. It reuses the *design* of the reference system (its breaking-change taxonomy, severity levels and the rule that two or more broken consumers need a person's decision), not its code, and it has no dependency on that repository. The reference system is Apache-2.0 licensed; this project is MIT licensed. Both are by Kavita Jadhav / K11 Software Solutions LLC.
How it compares
| Spec diff tools (e.g. oasdiff) | Consumer-driven contracts (e.g. Pact) | k11 API Contract QA | |
|---|---|---|---|
| Knows who breaks | No | Yes | Yes, field-level |
| Setup per consumer | None | Contract tests in every consumer | One YAML entry; discovery drafts it |
| Explains why | Rule only | Failing interaction | Rule, field, and what the consumer reads or sends |
| Formats | Usually one | HTTP and messages | OpenAPI, Swagger, GraphQL, gRPC, AsyncAPI, SOAP |
| Usable by an AI agent | No | No | Yes, over MCP |
Safety
- Specs, consumer folders and reports must be inside the project folder; git refs are read with
git show, never a shell. write_testwrites only undertests/orsrc/test/, and won't overwrite without asking.- Tokens for live checks are read from the environment (
${ENV:NAME}) and never echoed.
Development
python -m venv .venv && .venv/Scripts/pip install -