api-design SKILL.md skillC

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

Install it, pinned
mdr add atnexuslab/tightship/api-design@git:20261015.8e86e2c

Pins git:20261015.8e86e2c in mdr.lock. Pin the fingerprint instead.

Audit grade
C, 14 of 17 checks passed
Kind
SKILL.md skill
Repository
atnexuslab/tightship
Path
content/skills/api-design/SKILL.md
Versions recorded
1
Latest version
git:20261015.8e86e2c, committed Oct 15, 2026
Size
11,204 bytes
Repository stars
4
License
MIT

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

+++
name = "api-design"
description = "Use when designing or reviewing an API contract — REST, GraphQL, RPC, webhooks, events. Resources, methods, status codes, validation, error shape, idempotency, caching, versioning."
+++

# API Design

## When to use

Designing a new endpoint, service, or event contract — or reviewing an existing one for correctness,
consistency, and evolvability.

**Scope.** This skill decides the *contract*: what the API promises to callers. It never assumes a
language, framework, runtime, or architecture — those are the repository's decisions and live in its
own `AGENTS.md`. Apply the contract to whatever stack the repo already chose; when a framework idiom
conflicts with a rule here, name the conflict instead of silently bending either side.

## Method

1. **Name the consumers** and what each needs. A contract with no named consumer is speculation.
2. **Model the resource** — its identity, representation, and lifecycle (states and legal transitions).
3. **Specify each operation**: method, path, request schema, response schema, status codes, authz rule.
4. **Specify the failure modes** — every error a caller must handle, with its shape and status.
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add atnexuslab/tightship/api-design@sha256:abd73ff4f00b6f77

The line at the top of this page pins the label git:20261015.8e86e2c, 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_abxynwqna2uqmsjl.svg)](https://markdownregistry.com/a/art_abxynwqna2uqmsjl)

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

Versions

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

versioncommittedcommitsizeaudit
git:20261015.8e86e2c latest2026-10-15 8e86e2c 11,204 BC view

Audit of the latest version

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

Starting a new one? Use a template for SKILL.md on mdpantry, which passes every one of these checks and says what to change in it.

Source

GitHub

atnexuslab/tightship · 4 stars · license MIT · pushed 2026-10-22 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_abxynwqna2uqmsjl
GET https://markdownregistry.com/api/v1/resolve?ref=atnexuslab/tightship/api-design
GET https://markdownregistry.com/api/v1/blob/abd73ff4f00b6f77b6701f2fa9a54eb7db9d8334b2c283ccef609e026595e2e2

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 atnexuslab/tightship

cursor-plugin SKILL.md skill
atnexuslab/tightship · .claude/skills/cursor-plugin/SKILL.md · Use when building, rendering, or debugging the Cursor plugin of this repository — Cursor's plugin layout, what each…
git:20261017.0afecbf · audit A · 4 stars
AGENTS.md AGENTS.md file
atnexuslab/tightship · AGENTS.md
git:20261017.af09dc7 · audit A · 4 stars
architecture-reading SKILL.md skill
atnexuslab/tightship · content/skills/architecture-reading/SKILL.md
git:20261015.8e86e2c · audit C · 4 stars
database-design SKILL.md skill
atnexuslab/tightship · content/skills/database-design/SKILL.md
git:20261015.8e86e2c · audit C · 4 stars
frontend-architecture SKILL.md skill
atnexuslab/tightship · content/skills/frontend-architecture/SKILL.md
git:20261015.8e86e2c · audit C · 4 stars
grilling SKILL.md skill
atnexuslab/tightship · content/skills/grilling/SKILL.md
git:20261015.bf2e316 · audit C · 4 stars
hexagonal-architecture SKILL.md skill
atnexuslab/tightship · content/skills/hexagonal-architecture/SKILL.md
git:20261015.8e86e2c · audit C · 4 stars
performance-analysis SKILL.md skill
atnexuslab/tightship · content/skills/performance-analysis/SKILL.md
git:20261015.8e86e2c · audit C · 4 stars
project-docs SKILL.md skill
atnexuslab/tightship · content/skills/project-docs/SKILL.md
git:20261015.4cfc585 · audit C · 4 stars
requirements-engineering SKILL.md skill
atnexuslab/tightship · content/skills/requirements-engineering/SKILL.md
git:20261015.8e86e2c · audit C · 4 stars
security-audit SKILL.md skill
atnexuslab/tightship · content/skills/security-audit/SKILL.md
git:20261015.8e86e2c · audit C · 4 stars
spec-writing SKILL.md skill
atnexuslab/tightship · content/skills/spec-writing/SKILL.md
git:20261015.8e86e2c · audit C · 4 stars

Every file in atnexuslab/tightship

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 · 284,510 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 · 284,510 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 · 284,510 stars
api-design SKILL.md skill
affaan-m/ecc · docs/ja-JP/skills/api-design/SKILL.md · リソース命名、ステータス コード、ページネーション、フィルタリング、エラー応答、バージョン管理、およびレート制限を含む REST API デザイン パターン。
git:20260517.ec9ace9 · audit A · 284,510 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,076 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,352 stars
api-design SKILL.md skill
yonatangross/orchestkit · plugins/ork/skills/api-design/SKILL.md · API contract design for REST and GraphQL, covering resource shape, URL and header versioning with deprecation windows…
v2.0.0 · audit A · 296 stars
api-design SKILL.md skill
yonatangross/orchestkit · src/skills/api-design/SKILL.md · API contract design for REST and GraphQL, covering resource shape, URL and header versioning with deprecation windows…
v2.0.0 · audit A · 296 stars

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