Api Documentation
CheckedHelps with API, documentation as part of writing, documentation, and content creation workflows.
Install on your platform
Showing Claude Code. One command installs this skill into any of the agents below.
- 1
Run this in your project
terminal$ npx skills add bobmatnyc/claude-mpm-skills --skill api-documentation -a claude-code Uses the open-source
skillsCLI and needs Node.js. Add-gto install it for your user instead of this project.
What we know about this skill
Publisher
bobmatnyc
Taken from the source listing. We haven't verified who controls this account.
Install target
Live repository
Not pinned. Installing fetches whatever the repository holds at the time you run the command.
Automated safety checks
This skill passed all 6 checks. We read its files at one commit and looked for the things that make a skill dangerous to run — not for whether it works.
Declares what it does: passed
SKILL.md parses and declares a name and a description.
SKILL.md exists, its frontmatter parses, and it declares a name and a description.
No undeclared network calls: passed
Makes no network calls.
Every host the skill dials — from its scripts, its config endpoints or the commands it tells the agent to run — is either well-known package and API infrastructure or declared in its own frontmatter. Links in documentation are not counted.
No obfuscated payloads: passed
No encoded or obfuscated payloads.
No base64, hex or compressed blob is decoded and then executed, and no encoded shell commands.
No credential access: passed
Reads no keys, tokens, keychains or credential files.
Neither the code nor the SKILL.md instructions read SSH keys, cloud credentials, keychains, token stores, browser cookie databases or dotfiles that hold secrets.
No pipe-to-shell installers: passed
No pipe-to-shell or download-and-run installers.
No `curl … | sh` pattern, in the code or in the instructions, that runs code fetched at run time.
Pinned to a commit: passed
Scanned bobmatnyc/claude-mpm-skills at 718070a7d6.
The exact upstream commit SHA that was scanned is recorded, so the result refers to specific bytes.
- Commit
- 718070a7d6
- Scanned
- 2 files, 401 lines
About this skill
The api-documentation skill provides a structured approach to generating and organizing technical documentation for Application Programming Interfaces. It transforms raw code or endpoint lists into clear, readable guides that explain functionality, parameters, and usage examples. This tool is designed to streamline developer workflows by ensuring API details are consistently formatted and easily accessible.
-
Generate comprehensive documentation from existing API endpoints or code snippets.
-
Create quick reference guides for internal teams or external developers.
-
Convert complex technical specifications into user-friendly markdown or HTML formats.
-
Maintain consistent formatting standards across multiple API projects.
-
Endpoint parameter validation and description extraction
-
Usage example generation based on defined request/response schemas
-
Structured output in Markdown, JSON, or HTML formats
-
Automatic organization of endpoints by resource type or method (GET, POST, etc.)
"Generate API documentation for my REST service with examples in Python."
"Convert this list of GraphQL endpoints into a formatted markdown guide."
"Create a quick reference sheet for the authentication endpoints using OAuth2."
To get the best results, ensure your input includes clear endpoint definitions or code snippets. This skill works most effectively when provided with specific request/response schemas to generate accurate usage examples.