api-reference-quality SKILL.md skillA

api-reference-quality 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/api-reference-quality@v1.0.2

Pins v1.0.2 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/api-reference-quality/SKILL.md
Versions recorded
5
Latest version
v1.0.2, committed Oct 25, 2026
First version recorded
Aug 28, 2026
Size
17,825 bytes
Repository stars
9
License
MIT

Audit a published API reference at the endpoint level against its spec surface - every operation, parameter, response code, and error documented, request/response examples present, per-language code snippets in parity, try-it affordances working - and install the source-of-truth gates that stop reference drift (spec-driven generation, OpenAPI lint, contract tests, snippet parity in CI). Use whenever the user mentions API reference docs, OpenAPI docs completeness, undocumented endpoints or…

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 Reference Quality

You are an API reference auditor. Judge whether a published API reference documents the API's full contract surface completely enough that an integrator never has to guess, read source code, or open a ticket - then close the gaps through process, not one-off edits.

The frame is Fern's: reference documentation is a projection of the API contract; written by hand, it becomes a second copy kept in sync only by human effort. Diátaxis endorses the same move - reference material "can be generated automatically by the software it describes, which is a powerful way of ensuring that it remains faithfully accurate to the code." Every finding this audit produces is either a completeness gap or a drift mechanism, and the fix for drift is always structural.

The gaps are the industry norm, not the exception. Expect findings.

- OASQuali (ICWE 2026, 2,529 public OpenAPI specs) measured a mean documentation quality of 67.11%, with parameter examples absent from 86.95% of specs.
- Postman's 2024 State of the API survey (5,600+ respondents) found 39% call inconsistent docs their biggest roadblock and 44% dig through source code to understand APIs.

## Clarifying questions
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add samber/developer-platform-skills/api-reference-quality@sha256:5eedc1e4ff706769

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

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

Versions

The registry has recorded 5 versions of this file, between Aug 28, 2026 and Oct 25, 2026, about one every 15 days.

versioncommittedcommitsizeaudit
v1.0.2 latest2026-10-25 3737ca2 17,825 BA view · diff
v1.0.22026-10-25 4e87402 17,823 BA view · diff
v1.0.12026-09-27 3f8efdb 17,766 BA view · diff
v1.0.02026-08-28 d89e755 17,363 BA view · diff
v1.0.02026-08-28 7f57bf6 17,363 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 (17825 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_7qdz6drdicnnktek
GET https://markdownregistry.com/api/v1/resolve?ref=samber/developer-platform-skills/api-reference-quality
GET https://markdownregistry.com/api/v1/blob/5eedc1e4ff70676997f321fba6bf6baaee93ec601404e05b835cd8bcdb123ad5

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-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
api-versioning-policy SKILL.md skill
samber/developer-platform-skills · skills/api-versioning-policy/SKILL.md · Define the versioning and deprecation policy for an API - version scheme choice (URI path, header, date-based…
v1.0.3 · audit A · 9 stars

Every file in samber/developer-platform-skills

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