Serveur MCP api-contract-guardian
Commit 9 nov. 2026Detects breaking OpenAPI schema changes and generates migration guides to prevent API contract violations in CI/CD pipelines.
Aussi connu sous Coding-Dev-Tools/api-contract-guardian
- Étoiles
- 3
- Outils
- —
- Téléchargements, 30 jours
- —
- Dernière version
- —
- Dernier commit
- 9 nov. 2026
- Licence
- MIT
Qu'est-ce que api-contract-guardian MCP ?
api-contract-guardian est un serveur MCP. Detects breaking OpenAPI schema changes and generates migration guides to prevent API contract violations in CI/CD pipelines.
Résumé généré à partir du README du projet
À propos du MCP server api-contract-guardian
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.
Ce que vous pouvez faire avec
- 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.
Extrait du README du projet. Chaque cas d'utilisation est vérifié par rapport à une citation du document.
Vérifications automatisées
Exécuté le 15 nov. 2026Rapport complet →Pas encore vérifié. Un serveur nécessite un score de 80, aucune faille sérieuse et suffisamment de données pour que nous puissions effectuer les vérifications. Fonctionnement des vérifications · Ce qu'il faut corriger pour gagner des points
- Dépôt source lié et accessiblecoding-dev-tools/api-contract-guardian is public and reachablegithub.com/coding-dev-tools/api-contract-guardian ↗Réussi
- Le nom du package correspond au dépôt sourceNon vérifié
- Provenance du build (attestation Sigstore)Non vérifié
- Licence open source (OSI)MITspdx.org/licenses/MIT.html ↗Réussi
- Commit ou version publiée au cours de l'année écouléeLast commit or release 2026-11-09github.com/coding-dev-tools/api-contract-guardian ↗Réussi
- OpenSSF ScorecardNon vérifié
- Nom du package non proche d'un package populaireNon vérifié
- Aucun avis critique dans le package ou ses dépendancesNon vérifié
- Aucune instruction cachée destinée au modèle0 tool descriptions and the README read; no override phrases, credential paths or hidden charactersRéussi
- Les outils destructifs sont étiquetésNon vérifié
- Le point de terminaison distant répond à la poignée de main MCPNon vérifié
README
Voir sur GitHubAPI 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/
Questions sur 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.