api-contract-design SKILL.md skillA
api-contract-design from chadixearth/graphyloop is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add chadixearth/graphyloop/api-contract-design@git:20260816.37028bbPins git:20260816.37028bb in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- chadixearth/graphyloop
- Path
skills/api-contract-design/SKILL.md- Versions recorded
- 1
- Latest version
- git:20260816.37028bb, committed Aug 16, 2026
- Size
- 6,364 bytes
- Repository stars
- 3
- License
- MIT
Use this skill when freezing the interface between a backend and its clients before parallel work starts, or when changing an endpoint other code already calls - request/response shapes, status codes, error envelope, pagination, filtering, idempotency, versioning, and the breaking-change rules. Covers writing the contract as a checkable artifact so frontend, tests, and backend cannot drift.
Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.
What the file says
# API contract design
Parallel lanes fail at the seam: the backend returns `{data: {...}}`, the frontend
was written against `{...}`, and the tests mock a third shape. Freezing the contract
first is what makes wave-style parallel work safe (see `graphyloop-waves`) — this
skill is what "frozen" means in practice.
## When to activate
- Wave 0 / contract stage of any feature with a backend and a client.
- Adding an endpoint, or changing one that already has callers.
- A field rename, a nullable-to-required change, an error-shape change.
- "The frontend is broken but the API works" — usually a contract drift.
## The contract artifact
A contract is a file in the repo, not a paragraph in chat. One of:
- OpenAPI/JSON Schema (`openapi.yaml`) — best when clients are generated from it.
- A shared schema module (zod/valibot/pydantic) imported by both handler and client
— the type checker becomes the enforcer.
- A typed client + a fixtures file consumed by the tests.
Whichever you pick, it must state per endpoint: **method + path · auth + required
role/scope · path/query params with types and defaults · request body schema ·
…Read the whole file at its exact version.
How to install
mdr add chadixearth/graphyloop/api-contract-design@sha256:b3b2d7a6e6635f42The line at the top of this page pins the label git:20260816.37028bb, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.
[](https://markdownregistry.com/a/art_6mzobrgi65rcnr42)
2 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 1 version of this file, committed on Aug 16, 2026.
Audit of the latest version
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (6364 bytes)
- pass: No zero-width or bidi control characters
- pass: No instruction hidden inside an HTML comment
- pass: No link to an exfiltration or paste host
- pass: No credential-shaped string
- pass: No instruction to send local credentials anywhere
- pass: No text hidden with inline styles
- pass: No prompt-injection phrasing
- pass: No curl or wget piped into a shell
- pass: No recursive delete of root, home or parent
- pass: No instruction to read or print local credentials
- pass: No base64 blob over 200 characters
- pass: No link to a raw IP address
- pass: No script tag
Source
chadixearth/graphyloop · 3 stars · license MIT · pushed 2026-11-02 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_6mzobrgi65rcnr42 GET https://markdownregistry.com/api/v1/resolve?ref=chadixearth/graphyloop/api-contract-design GET https://markdownregistry.com/api/v1/blob/b3b2d7a6e6635f42546ae2ed33d2f6f4ec4044eb189d505a150570063434d6a7
Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.
Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.
More from chadixearth/graphyloop
Every file in chadixearth/graphyloop