Api Documentation

🌐Community
by bobmatnyc · vlatest · Repository

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.

1

Run in terminal (recommended)

terminal
claude mcp add bobmatnyc-api-documentation npx -- -y @trustedskills/bobmatnyc-api-documentation
2

Or manually add to ~/.claude/settings.json

~/.claude/settings.json
{
  "mcpServers": {
    "bobmatnyc-api-documentation": {
      "command": "npx",
      "args": [
        "-y",
        "@trustedskills/bobmatnyc-api-documentation"
      ]
    }
  }
}

Requires Claude Code (claude CLI). Run claude --version to verify your install.

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.

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 HubPass
SocketPass
SnykPass

Details

Version
vlatest
License
Author
bobmatnyc
Installs
65

🌐 Community

Passed automated security scans.