Api Documenter
Provides API guidance and assistance for writing, documentation, and content creation.
Install on your platform
We auto-selected Claude Code based on this skill’s supported platforms.
Run in terminal (recommended)
claude mcp add charon-fan-api-documenter npx -- -y @trustedskills/charon-fan-api-documenter
Or manually add to ~/.claude/settings.json
{
"mcpServers": {
"charon-fan-api-documenter": {
"command": "npx",
"args": [
"-y",
"@trustedskills/charon-fan-api-documenter"
]
}
}
}Requires Claude Code (claude CLI). Run claude --version to verify your install.
About This Skill
What it does
This skill, charon-fan-api-documenter, automatically generates documentation from API specifications. It takes an OpenAPI or Swagger file as input and produces human-readable markdown documentation suitable for developer portals or internal knowledge bases. The resulting documentation includes descriptions of endpoints, parameters, request bodies, and response schemas.
When to use it
- Documenting new APIs: Quickly create initial documentation when building a new API.
- Maintaining existing API docs: Keep documentation up-to-date as your API evolves without manual effort.
- Sharing API specifications internally: Provide clear and concise documentation for internal development teams.
- Generating public developer portals: Create publicly accessible documentation to enable third-party integrations.
Key capabilities
- Supports OpenAPI/Swagger specifications.
- Generates Markdown output.
- Automatically extracts information from API definitions.
- Provides descriptions of endpoints, parameters, request bodies and response schemas.
Example prompts
- "Generate markdown documentation for this API specification: [paste API spec here]"
- "Document the API at this URL in markdown format: [API URL]"
- “Create a developer-friendly guide from this OpenAPI definition.”
Tips & gotchas
- The skill requires a valid OpenAPI or Swagger file as input. Ensure your API specification is well-formed.
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.