What it does
Which services an API change breaks and why: OpenAPI, GraphQL, gRPC, AsyncAPI, SOAP.
- Connects 在你的电脑上运行
- Account or key No key needed
- Category 开发者工具
可搭配使用
教 AI 做这类工作的 Skill,可与本项一起使用
andrej-karpathy-skills
A single CLAUDE.md file to improve Claude Code behavior, derived from Andrej Karpathy's observations on LLM coding pitfalls.
graphify
Turn any codebase, with its docs, SQL schemas, configs, and PDFs, into a queryable knowledge graph. A /graphify skill for Claude Code, Cursor, Codex, and Gemini CLI: local deterministic AST parsing, every edge explained, no vector store.
为什么排在这里
列表按使用分(满分 100)排序,由以下部分组成
| 热度 | 0/80 | GitHub 星标或每周下载量:较大的计 60,较小的计 20 |
|---|---|---|
| 新鲜度 | 12/12 | 30 天内有发布或代码更新得满分 |
| 仍在响应 | 0/8 | 上次检查时云端端点有响应 |
| 使用分 | 12/100 |
质量: 基础检查通过 3/3 项(仅展示,不用于排序) · 上升势头: 暂无数据 (只用于“上升中”标签)
安装
选择你使用的 AI 应用,然后复制设置。
用一句话让 AI 帮你安装
请帮我安装 k11 API Contract QA。按照 https://mcp.popnx.com/i/k11-software-solutions-api-contract-qa.md 操作,先把命令给我看,等我同意后再运行。粘贴到能在你电脑上工作的 AI(如 Claude Code、Cursor)。它会读取我们的步骤,先给你看命令,等你同意。无需密钥,无需注册。 · 查看 AI 会读取的全文
通过 3/3 项检查 · 在你的电脑上运行 · ✓ 命令已检查 2026年11月14日
第一步:你用哪个 AI?
选择你用的应用,步骤会显示在下方。
可连接 Claude,但需要先准备
需要先在电脑上安装 Python (uv)(只需一次) · 仅限电脑上的 Claude 应用(Windows 或 Mac),网页和手机不可用
让 AI 帮你安装
把这段话复制到 Claude 的对话里。AI 会先检查电脑,告诉你要改哪个文件,并且每次都等你同意。
请在这台电脑上为 Claude 安装 MCP server k11 API Contract QA,按顺序:1) 用 uv --version 检查是否有 uv。没有的话,请让我从 https://docs.astral.sh/uv/getting-started/installation/ 安装,不要自己安装。2) 只使用这份配置(已通过 PopNx MCP 检查):{ "mcpServers": { "api-contract-qa": { "command": "uvx", "args": [ "k11-api-contract-qa-mcp" ] } } } 3) 告诉我要修改的文件完整路径或要运行的命令,等我同意。4) 不需要密钥。5) 按约定执行,然后确认 k11 API Contract QA 的工具真的出现了。这段话不包含你的密钥。如果需要密钥,AI 会请你自己粘贴到文件或应用的输入框里。
安装 uv(如果还没有)
已经装好了吗?先检查 · 打开终端,输入这条命令后按 Enter
uv --version- 显示版本号(例如 uv …)= 已安装,可跳过这一步
- 显示 "command not found"(Windows 显示 "is not recognized")= 还没安装,或刚装好但需要关掉终端再重新打开
怎么打开终端
Mac:按 ⌘ + Space,输入 Terminal 后按 Enter
Windows:打开“开始”菜单,输入 Windows PowerShell,然后选“打开”
还没安装: uv 没有点选式安装程序。从 uv 官方页面复制适合你系统(macOS 或 Windows)的一行命令,粘贴到终端 · 不需要单独安装 Python,uv 会在需要时自动下载
装好后关掉终端再打开,重新运行同一条命令,应显示版本号:
uv --version安装一次,所有需要 uv 的工具都能用
打开电脑版 Claude 应用的设置文件
SettingsDeveloperEdit Config
粘贴这些设置并保存文件
{ "mcpServers": { "api-contract-qa": { "command": "uvx", "args": [ "k11-api-contract-qa-mcp" ] } } }退出 Claude 再重新打开
试一试
用 k11 API Contract QA 告诉我你能帮我做什么,然后做一件给我看✓ 如果 Claude 说正在使用 k11 API Contract QA,或回答中出现 k11 API Contract QA 的工具名称,就表示连接成功
1 项可选设置(不填也能用)
上面的命令不填这些也能用。想调整时再按开发者的说明添加。
QA_MCP_ROOT包含规范文件的服务或代码仓库所在的文件夹(默认为当前目录)查看英文原文
Folder of the service or repo with the spec (default: current directory)
说明为自动翻译,变量名保持原样;不确定时请查看原文。
菜单名称已于 2026年11月11日 对照 Anthropic 帮助页面核实 · 你的界面可能因版本略有不同
ChatGPT 暂时无法连接 k11 API Contract QA
k11 API Contract QA 需要安装在你的电脑上,而 ChatGPT 只能连接在网上运行的服务器
你可以改用这些方式
A · 使用能连接 k11 API Contract QA 的应用
- 需要先在电脑上安装 Python (uv)(只需一次) · 仅限电脑上的 Claude 应用(Windows 或 Mac),网页和手机不可用
- 需要先在电脑上安装 Python (uv)(只需一次)
- 需要先在电脑上安装 Python (uv)(只需一次)
- 需要先在电脑上安装 Python (uv)(只需一次)
B · 开发者工具 类中能连接 ChatGPT 的其他服务器
从同类中使用较多的里挑选,仅限用地址即可连接、无需密钥的
- Sentry✓ ChatGPT
- Compiler Explorer✓ ChatGPT
- GitDiagram✓ ChatGPT
可连接 Claude Code,但需要先准备
需要先在电脑上安装 Python (uv)(只需一次)
让 AI 帮你安装
把这段话复制到 Claude Code 的对话里。AI 会先检查电脑,告诉你要改哪个文件,并且每次都等你同意。
请在这台电脑上为 Claude Code 安装 MCP server k11 API Contract QA,按顺序:1) 用 uv --version 检查是否有 uv。没有的话,请让我从 https://docs.astral.sh/uv/getting-started/installation/ 安装,不要自己安装。2) 只使用这份配置(已通过 PopNx MCP 检查):claude mcp add --scope user api-contract-qa -- uvx k11-api-contract-qa-mcp 3) 告诉我要修改的文件完整路径或要运行的命令,等我同意。4) 不需要密钥。5) 按约定执行,然后确认 k11 API Contract QA 的工具真的出现了。这段话不包含你的密钥。如果需要密钥,AI 会请你自己粘贴到文件或应用的输入框里。
安装 uv(如果还没有)
已经装好了吗?先检查 · 打开终端,输入这条命令后按 Enter
uv --version- 显示版本号(例如 uv …)= 已安装,可跳过这一步
- 显示 "command not found"(Windows 显示 "is not recognized")= 还没安装,或刚装好但需要关掉终端再重新打开
怎么打开终端
Mac:按 ⌘ + Space,输入 Terminal 后按 Enter
Windows:打开“开始”菜单,输入 Windows PowerShell,然后选“打开”
还没安装: uv 没有点选式安装程序。从 uv 官方页面复制适合你系统(macOS 或 Windows)的一行命令,粘贴到终端 · 不需要单独安装 Python,uv 会在需要时自动下载
装好后关掉终端再打开,重新运行同一条命令,应显示版本号:
uv --version安装一次,所有需要 uv 的工具都能用
打开终端
Mac:按 Command+空格,输入 Terminal · Windows:打开 PowerShell
粘贴这条命令并按 Enter
claude mcp add --scope user api-contract-qa -- uvx k11-api-contract-qa-mcp在 Claude Code 中输入 /mcp
应能看到 k11 API Contract QA 在列表中并显示已连接
试一试
用 k11 API Contract QA 告诉我你能帮我做什么,然后做一件给我看✓ 如果 Claude Code 说正在使用 k11 API Contract QA,或回答中出现 k11 API Contract QA 的工具名称,就表示连接成功
1 项可选设置(不填也能用)
上面的命令不填这些也能用。想调整时再按开发者的说明添加。
QA_MCP_ROOT包含规范文件的服务或代码仓库所在的文件夹(默认为当前目录)查看英文原文
Folder of the service or repo with the spec (default: current directory)
说明为自动翻译,变量名保持原样;不确定时请查看原文。
菜单名称已于 2026年11月11日 对照 Anthropic 帮助页面核实 · 你的界面可能因版本略有不同
可连接 Cursor,但需要先准备
需要先在电脑上安装 Python (uv)(只需一次)
让 AI 帮你安装
把这段话复制到 Cursor 的对话里。AI 会先检查电脑,告诉你要改哪个文件,并且每次都等你同意。
请在这台电脑上为 Cursor 安装 MCP server k11 API Contract QA,按顺序:1) 用 uv --version 检查是否有 uv。没有的话,请让我从 https://docs.astral.sh/uv/getting-started/installation/ 安装,不要自己安装。2) 只使用这份配置(已通过 PopNx MCP 检查):{ "mcpServers": { "api-contract-qa": { "command": "uvx", "args": [ "k11-api-contract-qa-mcp" ] } } } 3) 告诉我要修改的文件完整路径或要运行的命令,等我同意。4) 不需要密钥。5) 按约定执行,然后确认 k11 API Contract QA 的工具真的出现了。这段话不包含你的密钥。如果需要密钥,AI 会请你自己粘贴到文件或应用的输入框里。
安装 uv(如果还没有)
已经装好了吗?先检查 · 打开终端,输入这条命令后按 Enter
uv --version- 显示版本号(例如 uv …)= 已安装,可跳过这一步
- 显示 "command not found"(Windows 显示 "is not recognized")= 还没安装,或刚装好但需要关掉终端再重新打开
怎么打开终端
Mac:按 ⌘ + Space,输入 Terminal 后按 Enter
Windows:打开“开始”菜单,输入 Windows PowerShell,然后选“打开”
还没安装: uv 没有点选式安装程序。从 uv 官方页面复制适合你系统(macOS 或 Windows)的一行命令,粘贴到终端 · 不需要单独安装 Python,uv 会在需要时自动下载
装好后关掉终端再打开,重新运行同一条命令,应显示版本号:
uv --version安装一次,所有需要 uv 的工具都能用
在 Cursor 中以 Agent 模式打开 AI 聊天
试一试
用 k11 API Contract QA 告诉我你能帮我做什么,然后做一件给我看✓ 如果 Cursor 说正在使用 k11 API Contract QA,或回答中出现 k11 API Contract QA 的工具名称,就表示连接成功
1 项可选设置(不填也能用)
上面的命令不填这些也能用。想调整时再按开发者的说明添加。
QA_MCP_ROOT包含规范文件的服务或代码仓库所在的文件夹(默认为当前目录)查看英文原文
Folder of the service or repo with the spec (default: current directory)
说明为自动翻译,变量名保持原样;不确定时请查看原文。
菜单名称已于 2026年11月11日 对照 Cursor 帮助页面核实 · 你的界面可能因版本略有不同
可连接 VS Code,但需要先准备
需要先在电脑上安装 Python (uv)(只需一次)
让 AI 帮你安装
把这段话复制到 VS Code 的对话里。AI 会先检查电脑,告诉你要改哪个文件,并且每次都等你同意。
请在这台电脑上为 VS Code 安装 MCP server k11 API Contract QA,按顺序:1) 用 uv --version 检查是否有 uv。没有的话,请让我从 https://docs.astral.sh/uv/getting-started/installation/ 安装,不要自己安装。2) 只使用这份配置(已通过 PopNx MCP 检查):{ "servers": { "api-contract-qa": { "type": "stdio", "command": "uvx", "args": [ "k11-api-contract-qa-mcp" ] } } } 3) 告诉我要修改的文件完整路径或要运行的命令,等我同意。4) 不需要密钥。5) 按约定执行,然后确认 k11 API Contract QA 的工具真的出现了。这段话不包含你的密钥。如果需要密钥,AI 会请你自己粘贴到文件或应用的输入框里。
安装 uv(如果还没有)
已经装好了吗?先检查 · 打开终端,输入这条命令后按 Enter
uv --version- 显示版本号(例如 uv …)= 已安装,可跳过这一步
- 显示 "command not found"(Windows 显示 "is not recognized")= 还没安装,或刚装好但需要关掉终端再重新打开
怎么打开终端
Mac:按 ⌘ + Space,输入 Terminal 后按 Enter
Windows:打开“开始”菜单,输入 Windows PowerShell,然后选“打开”
还没安装: uv 没有点选式安装程序。从 uv 官方页面复制适合你系统(macOS 或 Windows)的一行命令,粘贴到终端 · 不需要单独安装 Python,uv 会在需要时自动下载
装好后关掉终端再打开,重新运行同一条命令,应显示版本号:
uv --version安装一次,所有需要 uv 的工具都能用
在 VS Code 中以 Agent 模式打开 AI 聊天
试一试
用 k11 API Contract QA 告诉我你能帮我做什么,然后做一件给我看✓ 如果 VS Code 说正在使用 k11 API Contract QA,或回答中出现 k11 API Contract QA 的工具名称,就表示连接成功
1 项可选设置(不填也能用)
上面的命令不填这些也能用。想调整时再按开发者的说明添加。
QA_MCP_ROOT包含规范文件的服务或代码仓库所在的文件夹(默认为当前目录)查看英文原文
Folder of the service or repo with the spec (default: current directory)
说明为自动翻译,变量名保持原样;不确定时请查看原文。
菜单名称已于 2026年11月11日 对照 VS Code 帮助页面核实 · 你的界面可能因版本略有不同
开发者专用:终端命令和 JSON 设置
安装在电脑上
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"
]
}
}
}需要你填写的值
QA_MCP_ROOTenv包含规范文件的服务或代码仓库所在的文件夹(默认为当前目录)查看英文原文
Folder of the service or repo with the spec (default: current directory)
说明为自动翻译,变量名保持原样;不确定时请查看原文。
这些设置是根据作者在注册中心的条目生成的。如果 README 的写法不同,请以 README 为准。
一览
哪些应用可以使用它
依据这个服务器的连接方式和各应用自己的文档,检查于 2026年11月10日。
在你的电脑上运行,适用于
ClaudeGooseLM StudioMsty StudioCherry StudioCursorVS Code + GitHub CopilotVisual StudioWindsurf (Devin Desktop)ZedKiroClineContinueJetBrains AI AssistantClaude CodeCodex CLIGemini CLIOpenCodenodecodeWarpLibreChatRaycast
它能做什么
它在你的电脑上运行;安装后,工具列表会显示在你的 AI 应用中。
基础检查i
我们检查的是任何人都能看到的信息;我们没有阅读代码。不适用的检查项不计入总数。 · 检查于 2026年11月19日
- ✓ 通过
作者与仓库一致
注册名称已通过 GitHub 账户 K11-Software-Solutions 验证,该账户拥有此仓库
- ✓ 通过
仍在维护
代码最后更新于3天前
- ✓ 通过
有许可证
使用 MIT
- – 不适用
端点有响应
它在你的电脑上运行,没有互联网端点
- – 不适用
使用 OAuth 登录
在你的电脑上运行,改用本地设置
- … 尚未检查
工具描述中没有隐藏指令
它在你的电脑上运行;我们只能读取互联网端点的工具列表
已公开的漏洞(OSV.dev)
OSV.dev 中没有 k11-api-contract-qa-mcp@0.1.0 的记录
只检查这个版本的包本身,不包括所有依赖 · 检查于 2026年11月16日
作者:申请重新检查或报告信息错误
给作者:在 README 中加徽章
如果你是作者,可把这段代码贴到 README。徽章会链接回本页。
[](https://mcp.popnx.com/en/servers/k11-software-solutions-api-contract-qa)讨论
提问、分享技巧或报告无法使用。按“有帮助”数量排序。
用户评价
还没有评价
与“开发者工具”中的其他服务器比较i
- 星标数多于此分类中其他 6116 个服务器的 0%
- 发布到注册中心的时间比此分类中其他 6116 个服务器的 88% 更新
- 基础检查结果等于或优于此分类中其他 6116 个服务器的 99%
与注册中心里这个分类中所有活跃的服务器比较。只有当发布者拥有该仓库时,星标数才计入。
常见问题
k11 API Contract QA 安全吗?
它在 3 项适用的基础检查中通过了 3 项。我们没有阅读代码。在添加密钥或令牌之前,请先看看这个服务器要求哪些权限,并使用只具备所需权限的密钥。
它需要哪些密钥或代码?
注册中心没有列出必需的密钥,不过有些服务器会在首次使用时要求你登录。
它在我的电脑上运行还是在云端?
它在你的电脑上运行。你的 AI 应用会在需要时启动它,数据不会经过作者的服务器(除非它自己调用在线服务)。
它还在维护吗?
GitHub 仓库最后更新于3天前,最新版本(0.1.0)于6天前进入注册中心。
哪些应用可以使用它?
支持 MCP 的应用,例如 Claude Desktop、Claude Code、Cursor 和 VS Code。你的电脑上还需要有 Python (uv)。
有什么可以替代它?
同一分类中有:GitDiagram, Appllama, Cloudflare MCP, Omnara, Repowise
功能相近的其他选择
同一分类、其他作者、命令已通过检查。官方的排在前面,再按星标排序。
如何看卡片:↓ 每周下载量i★ GitHub 星标i三大支柱:评价 · 检查 · 使用情况i更新 = 最新版本发布到注册中心的时间i
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.
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.
| 本项 k11 API Contract QA | GitDiagram | Appllama | Cloudflare MCP | Omnara | Repowise | |
|---|---|---|---|---|---|---|
| 运行位置 | 需要安装在电脑上 | 在云端运行,无需安装 | 在云端运行,无需安装 | 在云端运行,无需安装 | 在云端运行,无需安装 | 云端或安装在电脑上都可以 |
| 需要密钥 | 否 | 否 | 否 | 否 | 否 | 否 |
| 可在 Claude 中按 + 添加 | 否 | 否 | 否 | 是 | 否 | 否 |
| 基础检查 | 3/3 | 4/4 | 4/4 | 4/4 | 4/4 | 5/5 |
| 许可证 | MIT | MIT | MIT | Apache-2.0 | Apache-2.0 | AGPL-3.0 |
| 价格 | 登记中未列出费用 | 登记中未列出费用 | 登记中未列出费用 | 登记中未列出费用 | 登记中未列出费用 | 登记中未列出费用 |
作者的 README
打开 README
按原文从作者的仓库复制。PopNx MCP 没有审查或背书其内容。HTML、图片和脚本已被移除。链接会离开本站。
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 -