api-documentation-generator SKILL.md skillA
api-documentation-generator from aicodedecode/awesome-muse-skills is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.
mdr add aicodedecode/awesome-muse-skills/api-documentation-generator@git:20260927.806f3e1Pins git:20260927.806f3e1 in mdr.lock. Pin the fingerprint instead.
- Audit grade
- A, 17 of 17 checks passed
- Kind
- SKILL.md skill
- Repository
- aicodedecode/awesome-muse-skills
- Path
skills-imported/api-documentation-generator/SKILL.md- Versions recorded
- 1
- Latest version
- git:20260927.806f3e1, committed Sep 27, 2026
- Size
- 11,185 bytes
- Repository stars
- 25
- License
- MIT
Generate comprehensive, developer-friendly API documentation from code, including endpoints, parameters, examples, and best practices.
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 ## Overview Automatically generate clear, comprehensive API documentation from your codebase. This skill helps you create professional documentation that includes endpoint descriptions, request/response examples, authentication details, error handling, and usage guidelines. Perfect for REST APIs, GraphQL APIs, and WebSocket APIs. ## When to Use This Skill - Use when you need to document a new API - Use when updating existing API documentation - Use when your API lacks clear documentation - Use when onboarding new developers to your API - Use when preparing API documentation for external users - Use when creating OpenAPI/Swagger specifications ## How It Works ### Step 1: Analyze the API Structure First, I'll examine your API codebase to understand: - Available endpoints and routes - HTTP methods (GET, POST, PUT, DELETE, etc.) - Request parameters and body structure - Response formats and status codes - Authentication and authorization requirements - Error handling patterns ### Step 2: Generate Endpoint Documentation For each endpoint, I'll create documentation including: **Endpoint Details:** - HTTP method and URL path …
Read the whole file at its exact version.
How to install
mdr add aicodedecode/awesome-muse-skills/api-documentation-generator@sha256:4b4c6a6728108792The line at the top of this page pins the label git:20260927.806f3e1, 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_h4z3xvpkpzd67aw6)
2 badge image fetches in 30 days. What the badge shows.
Versions
The registry has recorded 1 version of this file, committed on Sep 27, 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 (11185 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
aicodedecode/awesome-muse-skills · 25 stars · license MIT · pushed 2026-10-10 · branch main
API
GET https://markdownregistry.com/api/v1/artifacts/art_h4z3xvpkpzd67aw6 GET https://markdownregistry.com/api/v1/resolve?ref=aicodedecode/awesome-muse-skills/api-documentation-generator GET https://markdownregistry.com/api/v1/blob/4b4c6a6728108792e224ecc5a36c52c08248cdd10eda7731891aa82ae5d6aebb
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 aicodedecode/awesome-muse-skills
Every file in aicodedecode/awesome-muse-skills