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 に従い、コマンドを見せて、私が OK するまで実行しないで。パソコンで作業できる AI(Claude Code や Cursor など)に貼り付けます。手順を読み、コマンドを見せて、あなたの OK を待ちます。キー不要・登録不要。 · AI が読む全文を見る
チェック 3/3 合格 · あなたのパソコンで動きます · ✓ コマンド確認済み 2026年11月14日
まず:どの AI を使っていますか?
使っているアプリを選ぶと、下に手順が表示されます。
Claude につなげますが、先に準備が必要です
先にパソコンへ Python (uv) を入れてください(1 回だけ) · パソコン版 Claude アプリ(Windows または Mac)のみ。Web やスマホでは使えません
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 公式ページからお使いの OS(macOS か Windows)用の 1 行コマンドをコピーしてターミナルに貼り付けます · 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 を使って、私に何ができるか教えて、1 つやってみせて✓ 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 は Web 上で動くサーバーにしかつなげません
代わりにできること
A · k11 API Contract QA につなげるアプリを使う
- 先にパソコンへ Python (uv) を入れてください(1 回だけ) · パソコン版 Claude アプリ(Windows または Mac)のみ。Web やスマホでは使えません
- 先にパソコンへ Python (uv) を入れてください(1 回だけ)
- 先にパソコンへ Python (uv) を入れてください(1 回だけ)
- 先にパソコンへ Python (uv) を入れてください(1 回だけ)
B · 開発者ツール の中で ChatGPT につなげる別のサーバー
同じカテゴリでよく使われているものから、キーなしでアドレスだけでつなげるものを選びました
- Sentry✓ ChatGPT
- Compiler Explorer✓ ChatGPT
- GitDiagram✓ ChatGPT
Claude Code につなげますが、先に準備が必要です
先にパソコンへ Python (uv) を入れてください(1 回だけ)
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 公式ページからお使いの OS(macOS か Windows)用の 1 行コマンドをコピーしてターミナルに貼り付けます · Python を別に入れる必要はなく、必要なときに uv が自動で取得します
入れ終わったらターミナルを閉じて開き直し、同じコマンドをもう一度実行します。バージョン番号が出れば完了です:
uv --version一度入れれば、uv を使うすべてのツールで使えます
ターミナルを開く
Mac:Command+スペースで Terminal と入力 · Windows:PowerShell を開く
このコマンドを貼り付けて Enter
claude mcp add --scope user api-contract-qa -- uvx k11-api-contract-qa-mcpClaude Code で /mcp と入力
k11 API Contract QA が一覧にあり、接続済みと表示されれば OK です
試してみる
k11 API Contract QA を使って、私に何ができるか教えて、1 つやってみせて✓ 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) を入れてください(1 回だけ)
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 公式ページからお使いの OS(macOS か Windows)用の 1 行コマンドをコピーしてターミナルに貼り付けます · Python を別に入れる必要はなく、必要なときに uv が自動で取得します
入れ終わったらターミナルを閉じて開き直し、同じコマンドをもう一度実行します。バージョン番号が出れば完了です:
uv --version一度入れれば、uv を使うすべてのツールで使えます
Cursor の AI チャットを Agent モードで開く
試してみる
k11 API Contract QA を使って、私に何ができるか教えて、1 つやってみせて✓ 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) を入れてください(1 回だけ)
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 公式ページからお使いの OS(macOS か Windows)用の 1 行コマンドをコピーしてターミナルに貼り付けます · Python を別に入れる必要はなく、必要なときに uv が自動で取得します
入れ終わったらターミナルを閉じて開き直し、同じコマンドをもう一度実行します。バージョン番号が出れば完了です:
uv --version一度入れれば、uv を使うすべてのツールで使えます
VS Code の AI チャットを Agent モードで開く
試してみる
k11 API Contract QA を使って、私に何ができるか教えて、1 つやってみせて✓ 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に従ってください。
ひと目でわかる
- 週あたりのダウンロードi
- npm/PyPIにない
- 接続方法
- パソコンで動く
- 最新バージョンi
- 0.1.0
- レジストリ公開日i
- 2026年11月13日
- コードの最終更新i
- 2026年11月16日
- 作者
- K11-Software-Solutions
- パッケージ
pypi: k11-api-contract-qa-mcp- ウェブサイト
- github.com
- レジストリでの状態
- 有効
使えるアプリ
このサーバーのつなぎ方と、各アプリの公式ドキュメントに基づきます。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 日前です。
どのアプリで使えますか?
Claude Desktop、Claude Code、Cursor、VS CodeなどのMCP対応アプリで使えます。パソコンにPython (uv)も必要です。
代わりに使えるものは?
同じカテゴリには:GitDiagram, Appllama, Cloudflare MCP, Omnara, Repowise
似た働きのほかの候補
同じカテゴリでほかの作者のもの。コマンドは確認済み。公式を先に、次にスター順。
カードの見方:↓ 週あたりのダウンロードi★ GitHubスターi3つの柱:レビュー · チェック · 利用状況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 -