api-design SKILL.md skillA

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

Install it, pinned
mdr add akillness/jeo-skills/api-design@v1.1.0

Pins v1.1.0 in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
akillness/jeo-skills
Path
.agent-skills/api-design/SKILL.md
Versions recorded
6
Latest version
v1.1.0, committed Nov 1, 2026
First version recorded
Jun 24, 2026
Size
10,277 bytes
Repository stars
52
License
none declared

Design or refactor API contracts for REST and GraphQL systems.

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

Use this skill to turn a vague integration idea, backend feature, or service boundary into a stable API contract that other skills can build on.

The job is not to generate pretty docs. The job is to:
- choose the right API style for the problem
- define resources, operations, inputs, outputs, and failure semantics
- make compatibility and versioning decisions explicit
- produce a contract artifact that implementation, testing, and documentation can share
- surface tradeoffs before the team hardens the wrong interface

Read [references/contract-review-checklist.md](references/contract-review-checklist.md) and [references/boundary-guide.md](references/boundary-guide.md) before handling unusual or high-risk API work.

If the user mainly needs:
- **reference docs, tutorials, example-heavy guides, or doc portal setup** → use `api-documentation`
- **auth implementation or token/session configuration** → use `authentication-setup`
- **contract/integration test strategy** → use `backend-testing`
- **schema/index/storage design** → use `database-schema-design`

## When to use this skill
- Design a new REST API, GraphQL schema, or internal service contract
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add akillness/jeo-skills/api-design@sha256:d2751fd6f9c8f2f1

The line at the top of this page pins the label v1.1.0, 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_bllntro66xcrln53.svg)](https://markdownregistry.com/a/art_bllntro66xcrln53)

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

Versions

The registry has recorded 6 versions of this file, between Jun 24, 2026 and Nov 1, 2026, about one every 26 days.

versioncommittedcommitsizeaudit
v1.1.0 latest2026-11-01 f625e09 10,277 BA view · diff
v1.1.02026-07-28 67be4c9 10,307 BA view · diff
v1.1.02026-07-27 056e3f8 10,340 BA view · diff
v1.1.02026-06-26 48fd3af 10,262 BA view · diff
v1.1.02026-06-26 4f9b684 10,259 BA view · diff
v1.1.02026-06-24 e051a1e 10,257 BA 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 (10277 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

akillness/jeo-skills · 52 stars · license none declared · pushed 2026-11-05 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_bllntro66xcrln53
GET https://markdownregistry.com/api/v1/resolve?ref=akillness/jeo-skills/api-design
GET https://markdownregistry.com/api/v1/blob/d2751fd6f9c8f2f19c7a9e4744af21b4867d1bb99b944501620d3da3ac9cd6ad

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 akillness/jeo-skills

a2a-protocol SKILL.md skill
akillness/jeo-skills · .agent-skills/a2a-protocol/SKILL.md · Agent-to-Agent horizontal messaging — Linux Foundation AAIF 2026 standard. Use when multiple agents across…
git:20260920.2a2b733 · audit A · 52 stars
ab-test-analysis SKILL.md skill
akillness/jeo-skills · .agent-skills/ab-test-analysis/SKILL.md · Analyze A/B test results with statistical significance, sample size validation, confidence intervals, and…
git:20260919.9f2a908 · audit A · 52 stars
academic-research SKILL.md skill
akillness/jeo-skills · .agent-skills/academic-research/SKILL.md · Full academic research pipeline from discovery to publication — 4 reference pipelines, 27 modes, 39-agent ensemble…
v1.0.0 · audit A · 52 stars
agent-beacon SKILL.md skill
akillness/jeo-skills · .agent-skills/agent-beacon/SKILL.md · Operate Asymptote-Labs/agent-beacon, the cross-harness coding-agent session history and self-improving memory layer…
v1.0.0 · audit A · 52 stars
agent-benchmarking SKILL.md skill
akillness/jeo-skills · .agent-skills/agent-benchmarking/SKILL.md · Map agent capabilities to standard benchmarks (SWE-bench, WebArena, OSWorld, GAIA, TauBench) plus custom regression…
git:20260919.9f2a908 · audit A · 52 stars
agent-guardrails SKILL.md skill
akillness/jeo-skills · .agent-skills/agent-guardrails/SKILL.md · Layered agent safety — prompt-injection defense, data exfiltration prevention, tool-misuse blocking via NeMo Guardrails…
git:20260919.9f2a908 · audit B · 52 stars
agent-manager SKILL.md skill
akillness/jeo-skills · .agent-skills/agent-manager/SKILL.md · tmux + Python agent lifecycle manager — start, stop, monitor, and assign tasks to AI agents running in tmux sessions…
v1.0 · audit A · 52 stars
agent-memory-architecture SKILL.md skill
akillness/jeo-skills · .agent-skills/agent-memory-architecture/SKILL.md · Design tiered agent memory — core / recall / archival — with backend selection (mem0, Letta, Zep/Graphiti, LangMem) and…
git:20260919.9f2a908 · audit A · 52 stars
agent-observability SKILL.md skill
akillness/jeo-skills · .agent-skills/agent-observability/SKILL.md · Instrument LLM agents with traces, metrics, and replay. Use when an agent in production is silently failing…
git:20260919.9f2a908 · audit A · 52 stars
agent-principles SKILL.md skill
akillness/jeo-skills · .agent-skills/agent-principles/SKILL.md · Core principles for collaborative development with AI agents. Defines divide-and-conquer, context management…
v2.0.0 · audit A · 52 stars
agent-pulse SKILL.md skill
akillness/jeo-skills · .agent-skills/agent-pulse/SKILL.md · Operate and extend barretlee/agent-pulse, the evidence-backed AI industry intelligence system: inspect source catalog…
v1.0 · audit A · 52 stars
agent-reach SKILL.md skill
akillness/jeo-skills · .agent-skills/agent-reach/SKILL.md · Operate Panniantong/Agent-Reach, the MIT-licensed installer, doctor, and routing layer for platform-specific internet…
v1.0.0 · audit A · 52 stars

Every file in akillness/jeo-skills

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 · 299,696 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 · 299,696 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 · 299,696 stars
api-design SKILL.md skill
affaan-m/ecc · docs/ja-JP/skills/api-design/SKILL.md · リソース命名、ステータス コード、ページネーション、フィルタリング、エラー応答、バージョン管理、およびレート制限を含む REST API デザイン パターン。
git:20260517.ec9ace9 · audit A · 299,696 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,537 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:20260729.3ecb845 · audit A · 505 stars
api-design SKILL.md skill
yonatangross/orchestkit · plugins/ork/skills/api-design/SKILL.md · API wire contracts for REST and GraphQL: resource shape, versioning and deprecation, RFC 9457 errors, OpenAPI. Use when…
v2.0.0 · audit A · 299 stars

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