api-design SKILL.md skillA

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

Install it, pinned

mdr add alexwaha/agentry/api-design@git:20261014.88e2c2f

Pins git:20261014.88e2c2f in mdr.lock. Pin the fingerprint instead.

Audit grade: A, 17 of 17 checks passed
Kind: SKILL.md skill
Repository: alexwaha/agentry
Path: plugin/skills/api-design/SKILL.md
Versions recorded: 1
Latest version: git:20261014.88e2c2f, committed Oct 14, 2026
Size: 4,058 bytes
Repository stars: 3
License: MIT

Design RESTful API endpoints, request/response schemas, error formats, and generate an OpenAPI 3.0 spec for a feature or the whole application. Use when a task says design/spec the API, add new endpoints, define request or response schemas, needs an OpenAPI/Swagger spec, plans resource routes and naming, or defines pagination/error envelope/versioning conventions before implementation.

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

Design complete API contracts for a feature or the entire application: endpoint
definitions, request/response schemas, error format, pagination, and an OpenAPI
spec. Concrete framework validation syntax and route conventions live in
`.agentry/project/stack.md`.

## Steps

1. **Read inputs.** Read `docs/product/product-spec.md`, `docs/technical/architecture.md`
   (if it exists), and `docs/business/product-vision.md` (if it exists). Identify
   scope: full API design or a single feature addition.
2. **Identify resources (nouns).** Extract every domain entity needing API
   representation. For each: name (singular/plural), type (primary, sub-resource,
   action endpoint), owner, access level. Build a resource inventory table.
   Example shapes: `references/api-examples.md`.
3. **Define RESTful endpoints per resource.** Standard CRUD set plus any
   non-CRUD action endpoints. Naming rules: plural nouns for collections
   (`/calendars`), singular verbs for actions on a resource
   (`/calendars/{id}/duplicate`), nested resources max 2 levels deep, query
   parameters for filtering/sorting/pagination never new verbs in the path.
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint

mdr add alexwaha/agentry/api-design@sha256:05d8139c2d474c87

The line at the top of this page pins the label git:20261014.88e2c2f, 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](https://markdownregistry.com/badge/art_mld2vwsyypcxgspi.svg)](https://markdownregistry.com/a/art_mld2vwsyypcxgspi)

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

Versions

The registry has recorded 1 version of this file, committed on Oct 14, 2026.

version	committed	commit	size	audit
git:20261014.88e2c2f latest	2026-10-14	88e2c2f	4,058 B	A	view

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 (4058 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

alexwaha/agentry · 3 stars · license MIT · pushed 2026-10-29 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_mld2vwsyypcxgspi
GET https://markdownregistry.com/api/v1/resolve?ref=alexwaha/agentry/api-design
GET https://markdownregistry.com/api/v1/blob/05d8139c2d474c87509e925370eddbe815bce1ebf83c7c2cdb2c2a79d13f6002

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.