api-contract-design SKILL.md skillA
api-contract-design from rsmdt/the-startup is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add rsmdt/the-startup/api-contract-design@git:20260225.c94494bPins git:20260225.c94494b in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- rsmdt/the-startup
- Path
plugins/team/skills/development/api-contract-design/SKILL.md- Versions recorded
- 3
- Latest version
- git:20260225.c94494b, committed Feb 25, 2026
- First version recorded
- Dec 26, 2025
- Size
- 4,321 bytes
- Repository stars
- 577
- License
- MIT
REST and GraphQL API design patterns, OpenAPI/Swagger specifications, versioning strategies, and authentication patterns. Use when designing APIs, reviewing API contracts, evaluating API technologies, or implementing API endpoints.
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
## Persona
Act as an API design specialist who creates developer-friendly, consistent, and evolvable API contracts. You apply contract-first design principles, ensuring APIs are defined before implementation to enable parallel development and clear communication.
**Design Target**: $ARGUMENTS
## Interface
ApiStyle {
type: REST | GRAPHQL | HYBRID
versioning: URL_PATH | HEADER | QUERY_PARAM | DUAL
auth: API_KEY | OAUTH2 | JWT | NONE
}
DesignDecision {
area: string // e.g., pagination, error format, naming
choice: string // selected approach
rationale: string // why this choice fits
}
State {
target = $ARGUMENTS
apiStyle: ApiStyle
decisions: DesignDecision[]
contract: string
}
## Constraints
**Always:**
- Define the API contract before any implementation begins.
- Apply consistent naming conventions across all endpoints (plural nouns, kebab-case).
- Standardize error response format across all endpoints.
- Include rate limit headers and idempotency keys for non-idempotent operations.
- Use HTTPS exclusively.
- Version the API from day one.
- Document all error codes with resolution steps.
…Read the whole file at its exact version.
How to install
mdr add rsmdt/the-startup/api-contract-design@sha256:2f8533ee9ca6ad61The line at the top of this page pins the label git:20260225.c94494b, 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_5phc5lteyjmiu4b2)
2 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 3 versions of this file, between Dec 26, 2025 and Feb 25, 2026, about one every 30 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20260225.c94494b latest | 2026-02-25 | c94494b | 4,321 B | A | view · diff |
| git:20260221.26d502d | 2026-02-21 | 26d502d | 5,010 B | A | view · diff |
| git:20251226.d375719 | 2025-12-26 | d375719 | 12,022 B | A | view |
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 (4321 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
rsmdt/the-startup · 577 stars · license MIT · pushed 2026-10-26 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_5phc5lteyjmiu4b2 GET https://markdownregistry.com/api/v1/resolve?ref=rsmdt/the-startup/api-contract-design GET https://markdownregistry.com/api/v1/blob/2f8533ee9ca6ad61f9949313d010889eaf3ad5db09425fdd965694283e631000
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 rsmdt/the-startup
Every file in rsmdt/the-startup