api-design SKILL.md skillA

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

Install it, pinned

mdr add frnkgns/gentjinskills/api-design@git:20260926.3185b84

Pins git:20260926.3185b84 in mdr.lock. Pin the fingerprint instead.

Audit grade: A, 17 of 17 checks passed
Kind: SKILL.md skill
Repository: frnkgns/gentjinskills
Path: skills/api-design/SKILL.md
Versions recorded: 1
Latest version: git:20260926.3185b84, committed Sep 26, 2026
Size: 1,941 bytes
Repository stars: 7
License: none declared

Review or design stable API contracts. Use when creating a new API, changing an existing contract, designing server/client interaction, adding pagination, filtering, or sorting, exposing an integration endpoint, or changing webhook and API behavior.

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

## Principle

Follow the project's existing API conventions. Do not require REST when the project already uses another valid architecture.

## Contract

- Request shape, types, and validation rules.
- Response shape, types, and stable field meanings.
- Naming consistency with existing endpoints and fields.
- Status codes and error contracts: machine-readable error codes, safe messages, and consistent structure.
- Nullable and optional fields: absence must be unambiguous.

## Operations

- Pagination: default page size, maximum size, cursor or offset, and total counts.
- Filtering and sorting: allowed fields, validation, and stable ordering.
- Versioning and backward compatibility: additive changes by default; never silently change field meaning or remove a field other consumers rely on.
- Idempotency for unsafe operations, and retry semantics that clients can rely on.
- Rate limits and abuse protection where the endpoint is exposed or costly.

## Webhooks and Integrations

- Signature verification and replay protection.
- Ordering assumptions, duplicate delivery tolerance, and versioning of the payload.
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint

mdr add frnkgns/gentjinskills/api-design@sha256:de197a8de78412ee

The line at the top of this page pins the label git:20260926.3185b84, 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_i3cmlndjl26c35hz.svg)](https://markdownregistry.com/a/art_i3cmlndjl26c35hz)

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

Versions

The registry has recorded 1 version of this file, committed on Sep 26, 2026.

version	committed	commit	size	audit
git:20260926.3185b84 latest	2026-09-26	3185b84	1,941 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 (1941 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

frnkgns/gentjinskills · 7 stars · license none declared · pushed 2026-10-21 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_i3cmlndjl26c35hz
GET https://markdownregistry.com/api/v1/resolve?ref=frnkgns/gentjinskills/api-design
GET https://markdownregistry.com/api/v1/blob/de197a8de78412eeb193d3f4401fa7c647765b24531f0e2d6ba3288df386d8d0

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 frnkgns/gentjinskills

gentjin Cursor rule

frnkgns/gentjinskills · .cursor/rules/gentjin.mdc · Overgeared Skills orchestration, skills, and memory rules

git:20261021.7da3b89 · audit A · 7 stars

AGENTS.md AGENTS.md file

frnkgns/gentjinskills · AGENTS.md

git:20261021.7da3b89 · audit A · 7 stars

CLAUDE.md CLAUDE.md file

frnkgns/gentjinskills · CLAUDE.md

git:20261021.7da3b89 · audit B · 7 stars

architecture-review SKILL.md skill

frnkgns/gentjinskills · skills/architecture-review/SKILL.md · Analyze significant cross-module or process-level structural changes before implementing them. Use when adding a…