api-contract-check
Skill0 starsChanged 13 days agoMITView on GitHub
Check API and schema changes for compatibility with existing clients and stored data. Use when editing public endpoints, CLI flags, event payloads, database schemas, or serialized formats.
2 other projects use a version of this.
Adopted by
Most recently taken up by
- hmcts/claudetheir own version, first seen Oct 13, 2026
- furenzhong/awoo-vibe-coding-governancetheir own version, first seen Sep 26, 2026
Other versions2 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 2
- hmcts/claude★ 1same name
- furenzhong/awoo-vibe-coding-governance★ 0same name
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository25 other files it gives its agents.
- AGENTS.mdAGENTS.md
- agent-skill-auditSkill
- build-rescueSkill
- change-narrativeSkill
- context-handoffSkill
- data-quality-gateSkill
- dataset-workshopSkill
- dependency-careSkill
- docs-syncSkill
- experiment-ledgerSkill
- failure-forensicsSkill
- model-diff-reviewSkill
- model-eval-designSkill
- multi-agent-crosscheckSkill
- parallel-task-designSkill
- performance-proofSkill
- release-readinessSkill
- repo-scoutSkill
- research-evidence-mapSkill
- review-lensSkill
- safe-migrationSkill
- security-surfaceSkill
- spec-firstSkill
- sql-integrity-checkSkill
- test-driven-changeSkill
The file
We split this skill into the rules it gives an agent
6 rules. About 0 are common, 6 are distinctive, and 0 are very specific to this project.
≈0
Common · estimate
Many files like this have a rule of this kind.
≈6
Distinctive · estimate
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 11
Search for callers and consumers.
- Distinctive: line 14
Prefer additive transitions: introduce a new field or endpoint, migrate consumers, observe adoption, then remove the old path only through …
- Distinctive: line 15
Add contract tests or fixtures representing real documented behavior.
- Distinctive: line 16
Update versioning, changelog, examples, and migration notes when the public contract changes.
- Distinctive: line 22
Do not run schema migrations against production or delete legacy data without explicit authorization.
- Distinctive: line 23
Treat undocumented behavior as uncertain.
≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
API Contract Check
Procedure
- Identify the contract: routes, method, status codes, auth, request/response schemas, CLI behavior, event topics, database fields, or file formats.
- Search for callers and consumers. Include generated clients, tests, docs, examples, scripts, downstream jobs, and stored historical data.
- Classify each change as additive, behavior-changing, or breaking. Check nullability, defaults, enum expansion, ordering, error semantics, pagination, and numeric/string representation.
- For database migrations, consider both old-code/new-schema and new-code/old-schema compatibility during rolling deployment.
- Prefer additive transitions: introduce a new field or endpoint, migrate consumers, observe adoption, then remove the old path only through an approved deprecation plan.
- Add contract tests or fixtures representing real documented behavior. Avoid relying only on implementation-specific unit tests.
- Update versioning, changelog, examples, and migration notes when the public contract changes.
Deliverable
Provide a compatibility matrix: old client/new server, new client/old server, existing data/new code, and rollback path.
Boundaries
- Do not run schema migrations against production or delete legacy data without explicit authorization.
- Treat undocumented behavior as uncertain; search usage before declaring it safe to break.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.