api-docs-generator SKILL.md skillA
api-docs-generator from pnp/copilot-prompts is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add pnp/copilot-prompts/api-docs-generator@git:20260218.376726bPins git:20260218.376726b in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- pnp/copilot-prompts
- Path
samples/skills/api-docs-generator/SKILL.md- Versions recorded
- 2
- Latest version
- git:20260218.376726b, committed Feb 18, 2026
- First version recorded
- Feb 18, 2026
- Size
- 8,641 bytes
- Repository stars
- 895
- License
- MIT
Generate structured API reference documentation from source code, OpenAPI specs, or route definitions. Trigger phrases include "generate API docs", "document this API", "create API reference", "write endpoint docs", "scaffold API 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 Generator
Generate clean, structured Markdown API reference docs from source code, OpenAPI/Swagger specs, or route definitions.
## Gather Context
Before writing anything, determine:
1. **Source** — Controller, route file, OpenAPI spec (JSON/YAML), or a set of files?
2. **API name** — e.g., "User Management API". Infer from class/file name if not stated.
3. **Base URL** — e.g., `https://api.example.com/v1`. Default to `https://api.example.com` if unknown.
4. **Auth method** — Bearer token (default), API key, OAuth 2.0, or none.
5. **Output format**:
- `single-file` (default) — one Markdown file with all endpoints
- `per-endpoint` — one file per endpoint (`{method}-{path-slug}.md`) plus a `README.md` index
6. **Language/framework** — Auto-detect from file extensions, imports, and decorators.
**If context is missing:** In conversational mode, ask. In agent/inline mode, use sensible defaults and note your assumptions at the top of the output.
## Analyzing the Source
### From Source Code
Read the file(s) and extract:
- Every endpoint: HTTP method + route path
- Route params, query params, request body schemas
…Read the whole file at its exact version.
How to install
mdr add pnp/copilot-prompts/api-docs-generator@sha256:67e1e793852790d9The line at the top of this page pins the label git:20260218.376726b, 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_ov7lpslqbsd4qigj)
3 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 2 versions of this file, all committed on Feb 18, 2026.
| version | committed | commit | size | audit | |
|---|---|---|---|---|---|
| git:20260218.376726b latest | 2026-02-18 | 376726b | 8,641 B | A | view · diff |
| git:20260218.2ed3c53 | 2026-02-18 | 2ed3c53 | 9,208 B | A | view |
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 (8641 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
pnp/copilot-prompts · 895 stars · license MIT · pushed 2026-10-18 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_ov7lpslqbsd4qigj GET https://markdownregistry.com/api/v1/resolve?ref=pnp/copilot-prompts/api-docs-generator GET https://markdownregistry.com/api/v1/blob/67e1e793852790d938600f173d35397e0daac3d78b3fd7afafd3865e54d6c71b
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 pnp/copilot-prompts
Every file in pnp/copilot-prompts