api-design-first SKILL.md skillA
api-design-first from jpeetz/agent-skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add jpeetz/agent-skills/api-design-first@v1.0.0Pins v1.0.0 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- jpeetz/agent-skills
- Path
skills/api-backend/api-design-first/SKILL.md- Versions recorded
- 2
- Latest version
- v1.0.0, committed Sep 14, 2026
- First version recorded
- Aug 31, 2026
- Size
- 12,154 bytes
- Repository stars
- 14
- License
- none declared
Design-first API development skill. Generates OpenAPI 3.1 specifications, enforces REST design best practices, validates endpoints, handles versioning, pagination, error formatting, authentication patterns, rate limiting, and idempotency. Activates when users say "design an API", "create OpenAPI spec", "API endpoint", "REST API design", "API contract", "Swagger/OpenAPI doc", "API versioning", "rate limiting", or "API security". Covers REST, GraphQL schema design, and gRPC proto generation with…
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 Design-First Design APIs before implementation. Generate OpenAPI 3.1 specifications, enforce REST best practices, and ensure cross-protocol consistency across REST, GraphQL, and gRPC. Every API design is reviewed for security, versioning, pagination, error handling, and developer experience. ## Role You are an API architect with experience designing APIs at Stripe, Twilio, and GitHub. You apply the design-first principle: the API contract is written before any code, and it drives implementation, testing, documentation, and client SDK generation. ## Design-First Workflow ``` Resource Model → OpenAPI 3.1 Spec → Spec Review → Mock Server → Implementation → Integration Tests ``` ### 1. Resource Modeling - Identify domain entities and their relationships - Define resource hierarchy (nested vs. flat) - Choose resource naming (plural nouns: `/users`, `/orders`) - Document state transitions ### 2. OpenAPI Specification Generation Generate a complete OpenAPI 3.1 spec with: - `info` (title, version, description, contact) - `servers` (dev, staging, production URLs) - `paths` (all endpoints with operations) - `components/schemas` (all data models) …
Read the whole file at its exact version.
How to install
mdr add jpeetz/agent-skills/api-design-first@sha256:80640522a5748e8fThe line at the top of this page pins the label v1.0.0, 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_l7rncqyhbyfaw55a)
3 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 2 versions of this file, between Aug 31, 2026 and Sep 14, 2026, about one every 14 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| v1.0.0 latest | 2026-09-14 | 5722530 | 12,154 B | A | view · diff |
| v1.0.0 | 2026-08-31 | 945bdcc | 12,153 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 (12154 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
jpeetz/agent-skills · 14 stars · license none declared · pushed 2026-10-19 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_l7rncqyhbyfaw55a GET https://markdownregistry.com/api/v1/resolve?ref=jpeetz/agent-skills/api-design-first GET https://markdownregistry.com/api/v1/blob/80640522a5748e8f26e525eecd2312805fe18ca9ffa049a62829db0e3f10895b
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 jpeetz/agent-skills
Every file in jpeetz/agent-skills