Skip to content
TrustedSkillsbeta
Back to all skills

Api Documenter

Checked
charon-fan·vlatest·backend·MIT

Provides API guidance and assistance for writing, documentation, and content creation.

Repository

Install on your platform

Showing Claude Code. One command installs this skill into any of the agents below.

  1. 1

    Run this in your project

    terminal
    $ npx skills add zhaono1/agent-playbook --skill api-documenter -a claude-code

  2. Uses the open-source skills CLI and needs Node.js. Add -g to install it for your user instead of this project.

What we know about this skill

Publisher

charon-fan

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.

No human has reviewed this code. The checks below are a static scan of the files at one commit — nobody has run this skill or judged whether it works. A skill runs with whatever access you give your agent, so read the source before you install it.

Automated safety checks

scanned

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 charon-fan/agent-playbook at be7a9d7d17.

    The exact upstream commit SHA that was scanned is recorded, so the result refers to specific bytes.

Commit
be7a9d7d17
Manifest
skills/api-documenter/SKILL.md
Scanned
7 files, 436 lines
This is a static scan, not a review. It reads the skill's files; it does not run them, and it cannot tell you whether the skill is any good or whether the code does what its description says. A skill runs with whatever access you give your agent.
What each check looks for →

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.