Api Documenter

🌐Community
by rmyndharis · vlatest · Repository

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.

1

Run in terminal (recommended)

terminal
claude mcp add rmyndharis-api-documenter npx -- -y @trustedskills/rmyndharis-api-documenter
2

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

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

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

About This Skill

What it does

The api-documenter skill automatically generates documentation from API specifications. It can process OpenAPI (Swagger) and AsyncAPI files, converting them into human-readable markdown documents. This simplifies the process of understanding and sharing information about APIs for developers and other stakeholders.

When to use it

  • Onboarding new team members: Quickly generate documentation to help new developers understand an existing API.
  • Sharing API details with external partners: Create clear, concise documentation for third-party integrations.
  • Automating documentation updates: Keep API documentation synchronized with code changes by automating the generation process.
  • Creating developer portals: Populate a developer portal with automatically generated API reference materials.

Key capabilities

  • Supports OpenAPI (Swagger) specifications.
  • Supports AsyncAPI specifications.
  • Generates markdown output.

Example prompts

  • "Generate documentation for this OpenAPI file: [URL to OpenAPI file]"
  • "Document the following AsyncAPI specification: [paste AsyncAPI content here]"
  • “Create a markdown document from this API definition.”

Tips & gotchas

  • The skill requires valid OpenAPI or AsyncAPI formatted input. Ensure your API specifications are correctly structured before using it.

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
rmyndharis
Installs
19

🌐 Community

Passed automated security scans.