public-api-design-review SKILL.md skillA

public-api-design-review from samber/developer-platform-skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add samber/developer-platform-skills/public-api-design-review@v1.0.3

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

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
samber/developer-platform-skills
Path
skills/public-api-design-review/SKILL.md
Versions recorded
6
Latest version
v1.0.3, committed Oct 25, 2026
First version recorded
Sep 1, 2026
Size
17,734 bytes
Repository stars
9
License
MIT

Audit an existing or proposed public REST API surface as a checklist-driven design review - resource and URI naming, HTTP method and status-code correctness, field-naming consistency, pagination pattern choice, filtering/sorting/field-selection conventions, one consistent error envelope, and Hyrum's-Law backward-compatibility risk - every finding bucketed Must-change or Improvement against a cited rule, plus the standing review program (audience, lifecycle triggers, reviewer authority…

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

# Public API Design Review

You are a public API design reviewer. Walk a REST API surface - shipped or still on paper - through a pass/fail checklist of the conventions external developers expect, bucket every finding as Must-change or Improvement with a cited rule, and, when asked, design the standing review program around the audit.

Zalando's guideline states the goal in one line: "great RESTful APIs look like they were designed by a single team." Cross-surface consistency, not any single endpoint's cleverness, is what you review for.

**Memory (advised):** When memory lives in a file, consider using `developer-platform-context.md`; if a different memory system is in use, rely on that instead. The file is an advisory reference, not a mandatory requirement. Separate task info in different sections. Remove finished tasks. Add a date to a task; no date for general project context. Some interview responses may differ between 2 tasks.

## Clarifying questions

Ask these before reviewing anything; each answer changes a later step. Batch them - this is a tactical audit, not a strategy interview.
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add samber/developer-platform-skills/public-api-design-review@sha256:8d31a2fbf5ffa52f

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

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

Versions

The registry has recorded 6 versions of this file, between Sep 1, 2026 and Oct 25, 2026, about one every 11 days.

versioncommittedcommitsizeaudit
v1.0.3 latest2026-10-25 4e87402 17,734 BA view · diff
v1.0.22026-10-22 10c4795 17,689 BA view · diff
v1.0.12026-10-22 846d310 17,689 BA view · diff
v1.0.12026-09-27 3f8efdb 17,521 BA view · diff
v1.0.02026-09-01 90539d3 17,118 BA view · diff
v1.0.02026-09-01 653d235 17,116 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 (17734 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

samber/developer-platform-skills · 9 stars · license MIT · pushed 2026-11-01 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_suoe47wglstckylq
GET https://markdownregistry.com/api/v1/resolve?ref=samber/developer-platform-skills/public-api-design-review
GET https://markdownregistry.com/api/v1/blob/8d31a2fbf5ffa52f40bf666c62935cf9f137415244c21cad2ef8958026593d88

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 samber/developer-platform-skills

agent-integration-surfaces SKILL.md skill
samber/developer-platform-skills · skills/agent-integration-surfaces/SKILL.md · Plans how a SaaS or developer platform opens itself to AI agents, provider side - which agent classes may reach which…
v1.0.0 · audit A · 9 stars
agent-skill-offering SKILL.md skill
samber/developer-platform-skills · skills/agent-skill-offering/SKILL.md · Ships an Agent Skill (SKILL.md) inside the GitHub repo of the library, CLI or SDK it documents, versioned with the code…
v1.0.2 · audit A · 9 stars
api-auth-key-management SKILL.md skill
samber/developer-platform-skills · skills/api-auth-key-management/SKILL.md · Design the API-key authentication surface a platform issues to its own API consumers - key format with prefix+checksum…
v1.0.2 · audit A · 9 stars
api-beta-program SKILL.md skill
samber/developer-platform-skills · skills/api-beta-program/SKILL.md · Runs an early-access, preview, beta or design-partner program for a new API feature: program shape, what each pre-GA…
v1.0.1 · audit A · 9 stars
api-changelog-automation SKILL.md skill
samber/developer-platform-skills · skills/api-changelog-automation/SKILL.md · Designs the provider-side pipeline that turns contract diffs of an API you publish (OpenAPI, GraphQL SDL, protobuf…
v1.0.1 · audit A · 9 stars
api-error-design SKILL.md skill
samber/developer-platform-skills · skills/api-error-design/SKILL.md · Design the error surface of a public API so integrators self-serve fixes - a machine-readable error-code taxonomy (flat…
v1.0.2 · audit A · 9 stars
api-idempotency-retry SKILL.md skill
samber/developer-platform-skills · skills/api-idempotency-retry/SKILL.md · Design idempotency-key support and client retry guidance for a public API so integrators retry safely - key derivation…
v1.0.1 · audit A · 9 stars
api-integration-surface-strategy SKILL.md skill
samber/developer-platform-skills · skills/api-integration-surface-strategy/SKILL.md · Decide which integration surfaces a platform offers external developers and AI agents - REST, GraphQL, gRPC, SQL…
v1.0.4 · audit A · 9 stars
api-rate-limit-policy SKILL.md skill
samber/developer-platform-skills · skills/api-rate-limit-policy/SKILL.md · Design the rate-limit policy a public API publishes to its consumers - the metering model per paradigm (REST request…
v1.0.1 · audit A · 9 stars
api-reference-quality SKILL.md skill
samber/developer-platform-skills · skills/api-reference-quality/SKILL.md · Audit a published API reference at the endpoint level against its spec surface - every operation, parameter, response…
v1.0.2 · audit A · 9 stars
api-status-communication SKILL.md skill
samber/developer-platform-skills · skills/api-status-communication/SKILL.md · Design how an API platform communicates status and incidents to external consumers - status-page modeling (the…
v1.0.1 · audit A · 9 stars
api-test-mode-design SKILL.md skill
samber/developer-platform-skills · skills/api-test-mode-design/SKILL.md · Design the test/sandbox mode of a public API platform so external integrators build and validate without touching real…
v1.0.2 · audit A · 9 stars

Every file in samber/developer-platform-skills

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