api-design skillA

api-design is agent-read markdown (skill) from nahid-sparktales/agent-dispatcher: Design or change an HTTP API — resources, verbs, status codes, one error shape, pagination, versioning, and an OpenAPI description that cannot drift from the handlers. Use when adding or reshaping endpoints, when asked what a response should return, or when reviewing whether a change to a published API breaks its consumers. Not for choosing between REST, GraphQL and RPC, not for database schema design, and not for implementing the handler's business logic..

Indexed from public GitHub and served as immutable, content-addressed versions. Install it pinned to an exact SHA-256 with the mdr CLI, and every file is verified against the hash recorded here before it reaches your agent. The deterministic audit below grades the latest version, and the same file always earns the same grade.

What the file says

# API design

The shape of an endpoint is a promise to code you do not control. Most of this skill exists to
stop a change being made casually that a consumer will experience as an outage.

## When this fires

Adding an endpoint, changing a response body, changing validation, or reviewing someone else's
API change. It does not fire for an internal function signature, or for a private endpoint with
exactly one caller in the same deployment unit — there, match the surrounding code and move on.

## Procedure

1. **Read the neighbours before designing anything.** Three or four existing endpoints: their URL
   style, error envelope, auth mechanism, pagination style, date format, casing. An endpoint that
   disagrees with the ones beside it is a defect even when it is individually better. If the
   existing API disagrees with itself, say so and pick the dominant convention — do not silently
   introduce a third.
2. **Name resources, not actions.** Plural nouns; nesting only where the child genuinely cannot
   exist without the parent. When an operation is a verb that resists this (`/orders/{id}/refunds`,
…

Read the whole file at its exact version.

How to install

mdr add nahid-sparktales/agent-dispatcher/api-design@git:20260919.a0d4f55

mdr add nahid-sparktales/agent-dispatcher/api-design@sha256:207d52d1978914a4

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

Versions

Audit of the latest version

Source

API

GET https://markdownregistry.com/api/v1/artifacts/art_oaz36u7x7kf7h7qm
GET https://markdownregistry.com/api/v1/resolve?ref=nahid-sparktales/agent-dispatcher/api-design
GET https://markdownregistry.com/api/v1/blob/207d52d1978914a4d516a7876a9e8d261a33bf96f84405122219007d1621efc9

Your agent 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.

More from nahid-sparktales/agent-dispatcher

Every file in nahid-sparktales/agent-dispatcher

Other files named api-design

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