Api Documentation
Helps with API, documentation as part of writing, documentation, and content creation workflows.
Install on your platform
We auto-selected Claude Code based on this skill’s supported platforms.
Run in terminal (recommended)
claude mcp add api-documentation npx -- -y @trustedskills/api-documentation
Or manually add to ~/.claude/settings.json
{
"mcpServers": {
"api-documentation": {
"command": "npx",
"args": [
"-y",
"@trustedskills/api-documentation"
]
}
}
}Requires Claude Code (claude CLI). Run claude --version to verify your install.
About This Skill
What it does
This skill generates clear and structured API documentation for web services, including endpoints, request/response formats, authentication methods, and usage examples. It supports multiple API frameworks and can automatically extract information from code or specifications.
When to use it
- You need to document a new RESTful API for developers to understand its structure and functionality.
- Your team is onboarding new members who require detailed API references.
- You want to generate documentation quickly without manually writing it from scratch.
- You're preparing technical documentation for an external developer audience or integration partners.
Key capabilities
- Generates markdown, HTML, or JSON-based API reference documents
- Supports OpenAPI/Swagger specification formats
- Extracts endpoint details from code or API definitions
- Includes examples of requests and responses
Example prompts
- "Generate API documentation for a user authentication service with endpoints for login, register, and profile retrieval."
- "Create a markdown-based API reference using the provided OpenAPI spec file."
- "Write documentation for an e-commerce API that includes payment processing and order management endpoints."
Tips & gotchas
- Ensure your code or specification is well-organized to get accurate results.
- For complex APIs, review generated documentation to ensure clarity and completeness.
Tags
TrustedSkills Verification
Unlike other registries that point to live repositories, TrustedSkills pins every skill to a verified commit hash. This protects you from malicious updates — what you install today is exactly what was reviewed and verified.
Security Audits
| Gen Agent Trust Hub | Pass |
| Socket | Pass |
| Snyk | Pass |
🌐 Community
Passed automated security scans.