api-design SKILL.md skillA

api-design from kbwen/agentic-os is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add kbwen/agentic-os/api-design@git:20261013.32bb1cc

Pins git:20261013.32bb1cc in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
kbwen/agentic-os
Path
.agents/skills/api-design/SKILL.md
Versions recorded
4
Latest version
git:20261013.32bb1cc, committed Oct 13, 2026
First version recorded
Apr 12, 2026
Size
4,069 bytes
Repository stars
237
License
MIT

Design or review REST/GraphQL APIs when endpoints or contracts change.

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

<!-- This is a SCAFFOLD skill -->

# API Design

## When to Apply

- **Classification**: feature, architecture-change, hotfix (if touching API endpoints)
- **Phase**: /implement (design & build), /review (compliance check), /test (contract verification)
- **Trigger**: Task involves creating, modifying, or deprecating API endpoints

## Conventions

> **Customize after /app-init**: Replace these generic conventions with your project's ADR decisions.

### Endpoint Naming
- Use nouns for resources, not verbs: `GET /users` not `GET /getUsers`
- Plural resource names: `/users`, `/orders`, `/products`
- Nested resources for relationships: `/users/:id/orders`
- Use kebab-case for multi-word paths: `/order-items`

### HTTP Methods
| Action | Method | Success Status | Idempotent |
|---|---|---|---|
| List | GET | 200 | Yes |
| Get one | GET | 200 | Yes |
| Create | POST | 201 | No |
| Full update | PUT | 200 | Yes |
| Partial update | PATCH | 200 | No |
| Delete | DELETE | 204 | Yes |

### Error Response Format
```json
{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Email is required",
    "details": {
      "field": "email",
      "constraint": "required"
    }
  }
}
```
…

Read the whole file at its exact version.

How to install

No tool to install first
claude plugin marketplace add https://markdownregistry.com/mp/a/art_ayzr6mxmm4uz3ugk/d1f9e506a8b5df8b3d440a9093106319039a4c14814cd9f7d1079ecb4210b867.json

Then /plugin install api-design@markdownregistry-ayzr6mxmm4uz3ugk in Claude Code. It installs git:20261013.32bb1cc, the one graded A here, pinned to the commit it was graded at, and leaves it there.

The exact contents, by fingerprint
mdr add kbwen/agentic-os/api-design@sha256:d1f9e506a8b5df8b

The line at the top of this page pins the label git:20261013.32bb1cc, 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.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_ayzr6mxmm4uz3ugk.svg)](https://markdownregistry.com/a/art_ayzr6mxmm4uz3ugk)

2 badge image fetches in 30 days. What the badge shows.

Ask from your agent
claude mcp add --transport http markdownregistry https://markdownregistry.com/mcp/registry

Then ask it: what changed in kbwen/agentic-os/api-design since the version I have? It reads every saved version here, no key and no account. Any agent that speaks MCP can add it.

Got a copy of api-design from somewhere else? Ask it: where did my api-design come from, and what was changed? It names the public original, the version yours is closest to and every changed line. The text is not kept.

Versions

The registry has recorded 4 versions of this file, between Apr 12, 2026 and Oct 13, 2026, about one every 61 days. Its first recorded version is graded C and its latest A.

Watch this file (sign in, one email per new version)

versioncommittedcommitsizeaudit
git:20261013.32bb1cc latest2026-10-13 32bb1cc 4,069 BA view · diff
git:20260729.37bc85b2026-07-29 37bc85b 4,069 BA view · diff
git:20260416.93348d42026-04-16 93348d4 4,168 BC view · diff
git:20260412.c1ced662026-04-12 c1ced66 3,982 BC view
Keep it current by itself, install once

Committed this skill to a repository? Install the markdownregistry skill updates app on it, or on all of them. When the registry saves a newer version, a pull request brings your copy to it within minutes, the newest version first, then what changed and any check it newly trips. A copy you edited is never touched, and nothing is deleted.

Install on GitHub

It asks to read and write contents and pull requests, and to read metadata. No workflow file, no Actions setting, nothing runs on your runners. Uninstall it and everything the registry kept about your repository is deleted.

Keep it current by itself

Committed this skill to a repository? Add one workflow file, and when a newer version is saved, a pull request brings your copy to it, the newest version first, then what changed and any check it newly trips. A copy you edited is never touched, and nothing is deleted.

mkdir -p .github/workflows && curl -fsSL https://markdownregistry.com/ci/skill-updates.yml -o .github/workflows/skill-updates.yml

It runs daily on GitHub Actions, no key and no account. Read the workflow before you add it.

Check a whole project

From the root of your project, one line hashes each installed skill's SKILL.md, your AGENTS.md and your CLAUDE.md, and asks the registry once. Only the fingerprints and paths are sent.

sha256sum .claude/skills/*/SKILL.md AGENTS.md CLAUDE.md | curl -s --data-binary @- https://markdownregistry.com/api/v1/check-copies

In CI, add --fail-with-body: the answer is 409 when any file is behind, so the step fails and still prints which files.

sha256sum .claude/skills/*/SKILL.md AGENTS.md CLAUDE.md | curl -s --fail-with-body --data-binary @- https://markdownregistry.com/api/v1/check-copies

No sha256sum on your machine? shasum -a 256 prints the same lines.

Audit of the latest version

A  17 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
  • pass: Frontmatter block present
  • pass: Frontmatter declares a name
  • pass: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (4069 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

GitHub

kbwen/agentic-os · 237 stars · license MIT · pushed 2026-11-13 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_ayzr6mxmm4uz3ugk
GET https://markdownregistry.com/api/v1/resolve?ref=kbwen/agentic-os/api-design
GET https://markdownregistry.com/api/v1/blob/d1f9e506a8b5df8b3d440a9093106319039a4c14814cd9f7d1079ecb4210b867

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 kbwen/agentic-os

auth-security SKILL.md skill
kbwen/agentic-os · .agents/skills/auth-security/SKILL.md · Secure authentication and authorization when credentials, sessions, roles, or permissions change.
git:20261013.32bb1cc · audit A · 237 stars
database-design SKILL.md skill
kbwen/agentic-os · .agents/skills/database-design/SKILL.md · Design schemas and migrations when persistent data structures change.
git:20261107.b65d54e · audit A · 237 stars
dispatching-parallel-agents SKILL.md skill
kbwen/agentic-os · .agents/skills/dispatching-parallel-agents/SKILL.md · Evaluate when to dispatch parallel agents; use a 4-step pattern to split, coordinate, and integrate results.
git:20260412.c1ced66 · audit A · 237 stars
doc-lookup SKILL.md skill
kbwen/agentic-os · .agents/skills/doc-lookup/SKILL.md · Check official docs when framework APIs or configuration may be version-sensitive.
git:20261013.32bb1cc · audit B · 237 stars
frontend-patterns SKILL.md skill
kbwen/agentic-os · .agents/skills/frontend-patterns/SKILL.md · Apply frontend conventions when components, pages, forms, or client state change.
git:20261013.32bb1cc · audit A · 237 stars
karpathy-principles SKILL.md skill
kbwen/agentic-os · .agents/skills/karpathy-principles/SKILL.md · Behavioral guidelines to reduce common LLM coding mistakes — Think Before Coding, Simplicity First, Surgical Changes…
git:20261013.32bb1cc · audit A · 237 stars
production-readiness SKILL.md skill
kbwen/agentic-os · .agents/skills/production-readiness/SKILL.md · Use at review and ship, automatically for feature or architecture changes and on request for error handling, logging…
git:20260910.7c13f5d · audit A · 237 stars
red-team-adversarial SKILL.md skill
kbwen/agentic-os · .agents/skills/red-team-adversarial/SKILL.md · Adversarial security and resilience analysis — auto-triggered during /review and /test based on task classification…
git:20261107.82203b5 · audit A · 237 stars
subagent-driven-development SKILL.md skill
kbwen/agentic-os · .agents/skills/subagent-driven-development/SKILL.md · Decompose tasks via subagent collaboration; define interface contracts and integration checkpoints.
git:20260412.c1ced66 · audit A · 237 stars
systematic-debugging SKILL.md skill
kbwen/agentic-os · .agents/skills/systematic-debugging/SKILL.md · Use when investigating a bug, test failure, flaky test, unexpected behavior, or a hotfix, or an unexplained or failed…
git:20260910.7c13f5d · audit A · 237 stars
test-driven-development SKILL.md skill
kbwen/agentic-os · .agents/skills/test-driven-development/SKILL.md · Drive changes with Red→Green→Refactor; ensure behavior is verifiable and regression-safe.
git:20261107.b65d54e · audit A · 237 stars
using-git-worktrees SKILL.md skill
kbwen/agentic-os · .agents/skills/using-git-worktrees/SKILL.md · Use Git worktrees to create parallel working directories safely; avoid branch-switch contamination.
git:20260620.0863319 · audit A · 237 stars

Every file in kbwen/agentic-os

Other files named api-design

api-design SKILL.md skill
affaan-m/ecc · docs/es/skills/api-design/SKILL.md · Patrones de diseño REST API incluyendo nomenclatura de recursos, códigos de estado, paginación, filtrado, respuestas de…
git:20260607.ac0f11c · audit A · 305,967 stars
api-design SKILL.md skill
affaan-m/ecc · .agents/skills/api-design/SKILL.md · REST API design patterns including resource naming, status codes, pagination, filtering, error responses, versioning…
git:20260918.c752aac · audit A · 305,967 stars
api-design SKILL.md skill
affaan-m/ecc · .kiro/skills/api-design/SKILL.md · REST API design patterns including resource naming, status codes, pagination, filtering, error responses, versioning…
git:20260323.535120d · audit A · 305,967 stars
api-design SKILL.md skill
affaan-m/ecc · docs/ja-JP/skills/api-design/SKILL.md · リソース命名、ステータス コード、ページネーション、フィルタリング、エラー応答、バージョン管理、およびレート制限を含む REST API デザイン パターン。
git:20260517.ec9ace9 · audit A · 305,967 stars
api-design SKILL.md skill
cbrock84/headcount · plugins/technology/skills/api-design/SKILL.md · Designs interfaces that survive their consumers — resource modeling, errors, versioning, pagination, and compatibility…
git:20260916.e72e404 · audit A · 2,543 stars
api-design SKILL.md skill
hashgraph-online/awesome-codex-plugins · plugins/Colin4k1024/tsp/skills/api-design/SKILL.md · REST API design patterns including resource naming, status codes, pagination, filtering, error responses, versioning…
git:20260512.6523792 · audit A · 1,584 stars
api-design SKILL.md skill
dragonked2/alphacode · src/alphacode_base/bundled_skills/api-design/SKILL.md · RESTful and GraphQL API design: OpenAPI specs, pagination, rate limiting, error schemas, versioning, and backwards…
git:20260923.ffaa29c · audit A · 626 stars
api-design SKILL.md skill
ericrisco/rsc-harness · skills/api-design/SKILL.md · Use when settling the contract of an API you expose, before implementation: resources/URLs, REST vs GraphQL…
git:20261109.ba0e80d · audit A · 608 stars

Browse by kind, by grade A, or by owner.

Kept in .agents/skills, the folder Codex reads. More agent skills for Codex.