api-contract-guardian MCPサーバー
コミット 2026年11月9日Detects breaking OpenAPI schema changes and generates migration guides to prevent API contract violations in CI/CD pipelines.
別名 Coding-Dev-Tools/api-contract-guardian
- スター
- 3
- ツール
- —
- ダウンロード数（30日間）
- —
- 最新バージョン
- —
- 最終コミット
- 2026年11月9日
- ライセンス
- MIT
api-contract-guardian MCPとは
api-contract-guardianはMCPサーバーです。 Detects breaking OpenAPI schema changes and generates migration guides to prevent API contract violations in CI/CD pipelines.
プロジェクトのREADMEから生成された概要
api-contract-guardian MCP server について
API Contract Guardian is a command-line tool designed for developers who maintain APIs and need to prevent breaking changes. It monitors OpenAPI schema differences between git branches, tags, or commits to ensure service boundaries remain intact. By comparing OpenAPI 3.0.x and 3.1.x specifications, the tool identifies issues like removed endpoints, changed data types, or renamed fields.
Users can integrate this tool into CI/CD pipelines to block pull requests that introduce contract violations. The software provides several commands, including check for detecting changes, migrate for creating documentation, and diff for comparing files. It supports multiple output formats such as JSON, YAML, and Markdown. While a free tier allows for a single spec comparison offline, professional tiers provide unlimited comparisons and CI/CD gating capabilities.
Installation is handled via pip, Homebrew, or Scoop. The tool functions locally without telemetry, making it suitable for secure environments. It is part of the Revenue Holdings suite of developer tools.
できること
- 1Prevent breaking API changesBlock pull requests in a CI/CD pipeline if they introduce breaking changes to the OpenAPI schema.
- 2Automate migration documentationGenerate a markdown file that explains how consumers should transition between different API versions.
- 3Verify schema differencesCompare two local OpenAPI specification files to identify removed properties or changed types.
プロジェクトの README から作成されています。すべてのユースケースは、その引用と照らし合わせて確認されています。
自動チェック
実行日 2026年11月15日完全なレポート →まだ検証されていません。サーバーには80点のスコア、重大な問題がないこと、および検証に必要な十分なデータが必要です。 チェックの仕組み · 点数を上げるための改善点
- ソースリポジトリがリンクされており、アクセス可能coding-dev-tools/api-contract-guardian is public and reachablegithub.com/coding-dev-tools/api-contract-guardian ↗合格
- パッケージがこのリポジトリをソースとして指定未チェック
- ビルドの来歴 (Sigstore 証明)未チェック
- オープンソースライセンス (OSI)MITspdx.org/licenses/MIT.html ↗合格
- 過去1年以内にコミットまたはリリースありLast commit or release 2026-11-09github.com/coding-dev-tools/api-contract-guardian ↗合格
- OpenSSF Scorecard未チェック
- パッケージ名が有名なパッケージに酷似していない未チェック
- パッケージおよびその依存関係に重大な勧告なし未チェック
- モデルへの隠れた指示がない0 tool descriptions and the README read; no override phrases, credential paths or hidden characters合格
- 破壊的なツールがラベル付けされている未チェック
- リモートエンドポイントが MCP ハンドシェイクに応答未チェック
README
GitHubで見るAPI Contract Guardian
Monitor OpenAPI schema diffs between git branches, detect breaking changes, generate migration guides, and block CI pipelines on contract violations.
|
⭐ Star this repo if you maintain APIs — it helps other devs discover API Contract Guardian!
|
|
Why API Contract Guardian?
Real-world scenarios:
- CI/CD gating: Block PRs that introduce breaking API changes — catch them before merge, not after deploy
- API version upgrades: When bumping v1 → v2, generate a migration guide for consumers automatically
- Microservice contract enforcement: Ensure service boundaries respect their OpenAPI contracts across deploys
- Client SDK regeneration: Know exactly what changed so SDK clients can be updated with confidence
Installation
Note:
api-contract-guardianis not yet on public PyPI. Use one of the methods below.
Install the latest version directly from GitHub:
pip install git+https://github.com/Coding-Dev-Tools/api-contract-guardian.git
Or install via Homebrew (macOS/Linux):
brew tap Coding-Dev-Tools/tap
brew install api-contract-guardian
Or install via Scoop (Windows):
scoop bucket add Coding-Dev-Tools https://github.com/Coding-Dev-Tools/scoop-bucket
scoop install api-contract-guardian
npm (Node.js wrapper — publishing pending):
# Not yet available — install via pip instead
Then run: api-contract-guardian --help
Quick Start
# Compare two spec files
api-contract-guardian check spec-v1.yaml spec-v2.yaml
# Generate migration guide
api-contract-guardian migrate spec-v1.yaml spec-v2.yaml --output MIGRATION.md
# CI gating (exits non-zero on breaking changes)
api-contract-guardian check spec-v1.yaml spec-v2.yaml
For machine-readable output, use --format yaml or --format json.
Example commands:
api-contract-guardian check spec-v1.yaml spec-v2.yaml --format yaml --output contract-diff.yaml
api-contract-guardian migrate spec-v1.yaml spec-v2.yaml --format json --output MIGRATION.json
Features
- Breaking Change Detection: Identifies removed endpoints, changed types, renamed fields, removed properties, and more
- Migration Guide Generation: Produces human-readable markdown migration guides
- Multiple Output Formats: Rich (terminal), JSON, YAML, or Markdown for
diffandmigrate; Rich, JSON, or YAML forcheck - CI Gating: Exits with non-zero code when breaking changes are detected
- OpenAPI 3.x Support: Full support for OpenAPI 3.0.x and 3.1.x specs
- Git Branch Diffing: Compare specs between branches, tags, or commits
- File Comparison: Compare two local spec files directly
Breaking Changes Detected
| Category | Example |
|---|---|
| Removed endpoint | DELETE /users/{id} removed |
| Removed property | email removed from User schema |
| Changed type | age changed from integer to string |
| Required property added | phone now required in User |
| Renamed field | name renamed to fullName |
| Response format changed | 200 response type changed |
| Endpoint auth changed | security dropped from DELETE /admin (now public) or a new scheme required |
CI/CD Integration
# Fail the build if breaking changes are detected
api-contract-guardian check spec-v1.yaml spec-v2.yaml || echo "Breaking API changes found!"
Pricing
API Contract Guardian is one of eleven tools in the Revenue Holdings suite. One license covers all CLI tools.
| Plan | Price | Best For |
|---|---|---|
| Free | $0 | Individual devs, OSS — CLI only, 1 spec comparison |
| ACG Individual | $19/mo ($15 billed annually) | Professional devs — unlimited specs, CI/CD gating |
| Suite (all 11 tools) | $49/mo ($39 billed annually) | Full Revenue Holdings toolkit — 40% savings |
| Team | $79/mo ($63 billed annually) | Up to 5 devs — shared dashboards, alerts, run history |
| Enterprise | Custom | SSO, RBAC, compliance reports, dedicated support |
🔹 No lock-in: CLI works fully offline on the free tier — no telemetry, no phone-home. 🔹 Annual billing: Save 20%.
Per-Tier Features
| Feature | Free | ACG | Suite | Team | Enterprise |
|---|---|---|---|---|---|
| CLI: diff, check, migrate | ✓ | ✓ | ✓ | ✓ | ✓ |
| Unlimited spec comparisons | — | ✓ | ✓ | ✓ | ✓ |
| CI/CD gating | — | ✓ | ✓ | ✓ | ✓ |
| Migration guide generation | — | ✓ | ✓ | ✓ | ✓ |
| Custom rules / policies | — | ✓ | ✓ | ✓ | ✓ |
| Team dashboard | — | — | — | ✓ | ✓ |
| Compliance reports | — | — | — | — | ✓ |
| RBAC | — | — | — | — | ✓ |
| SSO / SAML / OIDC | — | — | — | — | ✓ |
| Priority support | Community | 24h | 24h | 8h | Dedicated |
License
MIT
Install
api-contract-guardian is a Python CLI and is not on public PyPI:
pip install git+https://github.com/Coding-Dev-Tools/api-contract-guardian.git
For development: pip install -e .
Test
pytest tests/
api-contract-guardian MCPのよくある質問
Can I use this tool in my CI/CD pipeline?
Yes, the tool can be used for CI gating by exiting with a non-zero code when breaking changes are detected.
What kind of breaking changes does it detect?
It identifies removed endpoints, changed types, renamed fields, removed properties, and changes to required properties or authentication schemes.