api-design SKILL.md skillA
api-design from ahgraber/skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add ahgraber/skills/api-design@git:20260819.209d97bPins git:20260819.209d97b in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- ahgraber/skills
- Path
skills/api-design/SKILL.md- Versions recorded
- 5
- Latest version
- git:20260819.209d97b, committed Aug 19, 2026
- First version recorded
- Mar 30, 2026
- Size
- 8,421 bytes
- Repository stars
- 6
- License
- CC0-1.0
Use when designing, reviewing, or planning REST or GraphQL APIs — endpoint structure, schema design, versioning, error handling, pagination, URI naming, or choosing between REST and GraphQL. Also triggers for OpenAPI spec creation and API contract review.
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 ## When to Use - Designing new API endpoints or schemas - Reviewing existing API contracts for consistency - Choosing between REST and GraphQL for a project - Planning versioning, pagination, or error handling strategies - Creating or reviewing OpenAPI/GraphQL specifications - Naming URIs, fields, or resources - Reviewing API security posture **When NOT to use:** - Framework-specific implementation details (though FastAPI patterns are available as a secondary reference below) - Database schema design (unless it directly affects the API contract) - Frontend data fetching code (unless reviewing the API contract it consumes) ## Invocation Notice - Tell the user when this skill is running: `api-design`. Skip the notice when the user asked for the skill by name or slash command; spelling and spacing need not match. A phrase from this skill's own trigger list is not a name — naming the work is not naming the skill. ## Universal Principles These apply regardless of REST or GraphQL: 1. **Prefer design-first for public, cross-team, or governance-heavy APIs.** Write the contract (OpenAPI spec or GraphQL schema) before implementation. …
Read the whole file at its exact version.
How to install
mdr add ahgraber/skills/api-design@sha256:8869666845ac54a1The line at the top of this page pins the label git:20260819.209d97b, 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_ixy6lak2aug33v4s)
2 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 5 versions of this file, between Mar 30, 2026 and Aug 19, 2026, about one every 35 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20260819.209d97b latest | 2026-08-19 | 209d97b | 8,421 B | A | view · diff |
| git:20260728.79ff2f8 | 2026-07-28 | 79ff2f8 | 8,229 B | A | view · diff |
| git:20260501.212b304 | 2026-05-01 | 212b304 | 8,224 B | A | view · diff |
| git:20260403.e4173df | 2026-04-03 | e4173df | 7,889 B | A | view · diff |
| git:20260330.ffc7ef5 | 2026-03-30 | ffc7ef5 | 5,893 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 (8421 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
ahgraber/skills · 6 stars · license CC0-1.0 · pushed 2026-10-29 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_ixy6lak2aug33v4s GET https://markdownregistry.com/api/v1/resolve?ref=ahgraber/skills/api-design GET https://markdownregistry.com/api/v1/blob/8869666845ac54a17012b4a9aebb3f2e6f9a183e8617fda0cf1d2e2797f4de1f
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.