api-documentation SKILL.md skillA
api-documentation from okhp3/skillz is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add okhp3/skillz/api-documentation@git:20260828.866dec6Pins git:20260828.866dec6 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- okhp3/skillz
- Path
community/api-documentation/SKILL.md- Versions recorded
- 1
- Latest version
- git:20260828.866dec6, committed Aug 28, 2026
- Size
- 4,522 bytes
- Repository stars
- 3
- License
- MIT
Documents an interface others will call — endpoints, SDK methods, CLI commands, and their parameters, errors, and limits. Use this whenever the user needs API docs, an OpenAPI spec, reference documentation, docstrings for a public library, or has an interface that people keep asking questions about. For designing the interface itself, use api-design; for prose guides and READMEs, use markdown-docs.
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 documentation Reference documentation is not read; it is searched. Someone arrives mid-task with a specific question — what does this return, what happens when it fails, is this required, and leaves as soon as they have the answer. Optimise for that. Completeness beats narrative, and the questions people actually have are rarely the ones the happy-path example answers. ## 1. Generate the mechanical parts Signatures, types, parameter lists, and status codes should come from the code — OpenAPI from annotations, docstrings extracted, CLI help generated. Anything hand-maintained drifts, and wrong reference documentation is worse than none because it is believed. Hand-write only what cannot be derived: why, when, what happens on failure, and the constraints the type system does not express. **Done when:** no fact appears in both the code and the docs, maintained separately. ## 2. Document each parameter properly A name and a type are not documentation. For each parameter: - **What it means**, in domain terms - **Required or optional**, and the default if optional — the default is the most frequently looked up fact and the most frequently missing …
Read the whole file at its exact version.
How to install
mdr add okhp3/skillz/api-documentation@sha256:91b53ba1261b4190The line at the top of this page pins the label git:20260828.866dec6, 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.
[](https://markdownregistry.com/a/art_7gm6eivbq274ytlo)
6 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 1 version of this file, committed on Aug 28, 2026.
Audit of the latest version
- pass: Frontmatter block present
- pass: Frontmatter declares a name
- pass: Frontmatter declares a description
- pass: Size between 200 bytes and 200 KB (4522 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
okhp3/skillz · 3 stars · license MIT · pushed 2026-11-06 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_7gm6eivbq274ytlo GET https://markdownregistry.com/api/v1/resolve?ref=okhp3/skillz/api-documentation GET https://markdownregistry.com/api/v1/blob/91b53ba1261b4190c8d58d6f0f58783bd5e71b295a7995af39c818ecbe51cbf8
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.