api-design SKILL.md skillA
api-design from event4u-app/agent-config is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add event4u-app/agent-config/api-design@git:20261013.503b4e9Pins git:20261013.503b4e9 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- event4u-app/agent-config
- Path
src/skills/api-design/SKILL.md- Versions recorded
- 5
- Latest version
- git:20261013.503b4e9, committed Oct 13, 2026
- First version recorded
- Jun 3, 2026
- Size
- 4,715 bytes
- Repository stars
- 19
- License
- MIT
Use when designing APIs, planning endpoints, REST conventions, versioning, or deprecation — even when the user just says 'expose this as an endpoint' without naming API design.
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 > **Grounded corpus (Tier-1 consultation):** pagination, versioning, > error shape (RFC 9457), idempotency, async ops, rate limiting, bulk, > naming, expansion, webhooks — query `node > <skills-root>/corpus-grounding/scripts/ground.mjs search --manifest > <skills-root>/api-design/data/manifest.json "<concern>"` and propose > the grounded pattern (+ hardening + anti-patterns + RFC link) before > designing from memory. Corpus: [`data/api-patterns.csv`](data/api-patterns.csv). ## When to use Use this skill when designing new API endpoints, restructuring existing APIs, or deciding about versioning and deprecation. Do NOT use when: - Implementing an already-designed endpoint (use `api-endpoint` skill) - Writing tests for APIs (use `api-testing` skill) ## Procedure: Design an API 1. **Gather context** — read `agents/settings/contexts/api-versioning.md`, `agents/reference/docs/api-resources.md`, `agents/reference/docs/query-filter.md`, `agents/reference/docs/controller.md`, and guideline `php/api-design.md`. 2. **Identify the resource** — determine the domain entity, its attributes, and relationships. Check existing models and resources for field naming patterns. …
Read the whole file at its exact version.
How to install
mdr add event4u-app/agent-config/api-design@sha256:511c8158dd3ed63dThe line at the top of this page pins the label git:20261013.503b4e9, 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_dunyozxu7xj5bf6v)
7 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 5 versions of this file, between Jun 3, 2026 and Oct 13, 2026, about one every 33 days.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20261013.503b4e9 latest | 2026-10-13 | 503b4e9 | 4,715 B | A | view · diff |
| git:20260711.0f04776 | 2026-07-11 | 0f04776 | 4,720 B | A | view · diff |
| git:20260707.4f7f4a8 | 2026-07-07 | 4f7f4a8 | 4,606 B | A | view · diff |
| git:20260607.1e9e435 | 2026-06-07 | 1e9e435 | 4,554 B | A | view · diff |
| git:20260603.668ed88 | 2026-06-03 | 668ed88 | 4,118 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 (4715 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
event4u-app/agent-config · 19 stars · license MIT · pushed 2026-11-05 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_dunyozxu7xj5bf6v GET https://markdownregistry.com/api/v1/resolve?ref=event4u-app/agent-config/api-design GET https://markdownregistry.com/api/v1/blob/511c8158dd3ed63dec88d42e527d61f10c14a24140e570e7d3b38a20e4c2a338
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 event4u-app/agent-config
Every file in event4u-app/agent-config