New: 97,000+ skills indexed from GitHub repos with 100+ stars · every skill safety-checkedBrowse top skillsTop skills
Esc to closeBrowse all skills
Submit a skillBrowse skills
Submit a skillBrowse skills

Agent skill

API Docs

by ruvnet in ruvnet/ruflo

Generate API documentation from source code with JSDoc and OpenAPI support

MITAuto-check passedDevelopment

Install API Docs

skills CLI
$ npx skills add ruvnet/ruflo --skill api-docs -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install ruvnet/ruflo api-docs --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/ruvnet/ruflo.git skills-src && mkdir -p .claude/skills && cp -r skills-src/plugins/ruflo-docs/skills/api-docs .claude/skills/api-docs && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
api-docs
GitHub stars
74k
Used in
1 other repo
Token cost
~239 tokens
SKILL.md length
85 words
Files
1
Skills in repo
264
Repo updated
First seen
Licence
MIT

At a glance

Generate API documentation from source code with JSDoc and OpenAPI support

  • Works in 4 steps: Scan exports: Find all public functions,… → Extract JSDoc: Parse @param, @returns,… → Generate missing docs: Add JSDoc for… → …
  • Tasks that involve Technical documentation
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
  • Tasks that involve OpenAPI specifications

What it does

API Docs is an agent skill from ruvnet/ruflo. Generate API documentation from source code with JSDoc and OpenAPI support

Its SKILL.md is about 240 tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

It sits in Development, covering Technical documentation and OpenAPI specifications. It works with OpenAPI. The repository describes itself as: 🌊 The original agent harness. Deploy intelligent multi-player swarms, coordinate autonomous workflows, and build conversational AI systems. Features adaptive memory…. The licence is MIT.

When your agent uses it

  • Tasks that involve Technical documentation
  • Tasks that involve OpenAPI specifications

Example prompts

  • “/api-docs”

Requirements

  • Node.js
  • Pre-approved tools (allowed-tools): Bash(npx *), mcp__plugin_ruflo-core_ruflo__hooks_worker-dispatch, Read, Write, Grep

Workflow steps

4 steps, taken from the first numbered list in SKILL.md.

  1. Scan exports: Find all public functions, classes, and interfaces
  2. Extract JSDoc: Parse @param, @returns, @throws, @example annotations
  3. Generate missing docs: Add JSDoc for undocumented public APIs
  4. OpenAPI spec: For HTTP endpoints, generate OpenAPI 3.0 definitions

What it can do on your machine

Read from SKILL.md and the folder at commit de590e1. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves these tools, so the agent can use them without asking each time:

    • Bash(npx *)
    • mcp__plugin_ruflo-core_ruflo__hooks_worker-dispatch
    • Read
    • Write
    • Grep

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    No scripts in the folder and no shell commands in SKILL.md.

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

API Docs loads about 239 tokens when it runs. Until then it costs about 21 tokens; SKILL.md has 85 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~21
When it runs · the whole SKILL.md, loaded when a task matches
~239

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from ruvnet/ruflo at commit de590e1, republished under its MIT licence (© ruvnet). 85 words, ~239 tokens.

Download SKILL.mdSave it as .claude/skills/api-docs/SKILL.md (or your agent's skills folder).
name
api-docs
description
Generate API documentation from source code with JSDoc and OpenAPI support
allowed-tools
Bash(npx *), mcp__plugin_ruflo-core_ruflo__hooks_worker-dispatch, Read, Write, Grep
argument-hint
<source-path>

Generate API documentation from TypeScript/JavaScript source:

  1. Scan exports: Find all public functions, classes, and interfaces
  2. Extract JSDoc: Parse @param, @returns, @throws, @example annotations
  3. Generate missing docs: Add JSDoc for undocumented public APIs
  4. OpenAPI spec: For HTTP endpoints, generate OpenAPI 3.0 definitions

Dispatch via MCP: mcp__plugin_ruflo-core_ruflo__hooks_worker-dispatch({ trigger: "document", scope: "api" })

Conventions:

  • Every public export must have a JSDoc comment
  • Include @param with type and description
  • Include @returns with type and description
  • Include @throws for known error conditions
  • Include @example for non-obvious usage

© ruvnet, MIT. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in plugins/ruflo-docs/skills/api-docs of ruvnet/ruflo.

Open the folder on GitHubat commit de590e1

Used in 1 other repository

We found 3 copies of this SKILL.md (exact, near-identical or edited) in other folders, from 1 other GitHub owner. This page covers the copy in ruvnet/ruflo, which our catalogue first saw on October 7, 2026.

Compare with similar skills

API Docs next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

API Docs compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
API Docs this skillruvnet/ruflo74k1 repos~239Automated safety check: PassMIT
Nacos API Doc Updatenacos-group/nacos-group.github.io115—~3.3kAutomated safety check: PassApache-2.0
API Documentation Generatorluongnv89/claude-howto42k—~429Automated safety check: PassMIT
Dashclaw Shipucsandman/DashClaw310—~7.2kAutomated safety check: PassMIT
Agentic Workflows API Documentation Lungoagntcy/coffeeAgntcy112—~2.6kAutomated safety check: PassApache-2.0
Code DocumenterJeffallan/claude-skills12k—~1.5kAutomated safety check: PassMIT

Similar skills

  • Nacos API Doc Update

    nacos-group/nacos-group.github.io

    Updates Nacos API documentation from Swagger api.json. An agent skill from nacos-group/nacos-group.github.io.

    115 GitHub stars~3.3k tokensUpdated 13 days ago
    DevelopmentAuto-check passed

  • API Documentation Generator

    luongnv89/claude-howto

    Generate comprehensive, accurate API documentation from source code. Use when creating or updating API documentation, generating OpenAPI specs, or when users…

    42k GitHub stars~429 tokensUpdated 7 days ago
    DevelopmentAuto-check passed

  • Dashclaw Ship

    ucsandman/DashClaw

    The single command that gets a DashClaw change ON MAIN AND LIVE — it resolves everything blocking production, never defers, and never hands back a checklist.

    310 GitHub stars~7.2k tokensUpdated yesterday
    DevelopmentAuto-check passed

  • Agentic Workflows API Documentation Lungo

    agntcy/coffeeAgntcy

    Authors and maintains the human-facing Agentic Workflows API documentation for the lungo subproject at coffeeAGNTCY/coffeeagents/lungo/docs/workflow-instanceapi.md.

    112 GitHub stars~2.6k tokensUpdated yesterday
    DevelopmentAuto-check passed

  • Code Documenter

    Jeffallan/claude-skills

    Generates and validates docstrings, OpenAPI specs, JSDoc annotations and user guides, running every code example through a real compiler or linter before reporting coverage.

    12k GitHub stars~1.5k tokensUpdated 4 days ago
    DevelopmentAuto-check passed

  • API Documentation Generator (Ukrainian)

    luongnv89/claude-howto

    Ukrainian-language skill for writing API documentation from source code: OpenAPI specs, endpoint pages, SDK examples, integration and authentication guides and error code references.

    42k GitHub stars~375 tokensUpdated 7 days ago
    DevelopmentAuto-check passed

More from ruvnet/ruflo

All 264 skills in this repo

  • AgentDB Pattern Memory

    ruvnet/ruflo

    Stores, searches, and retrieves successful patterns with HNSW-indexed semantic search so agents can reuse past solutions instead of relearning them.

    74k GitHub starsUsed in 2 repos~830 tokens
    Auto-check passed

  • Security Audit Scanner

    ruvnet/ruflo

    Runs claude-flow CLI security scans for input validation, path traversal, SQL injection, XSS, hardcoded secrets and known CVEs, and writes an audit report.

    74k GitHub starsUsed in 2 repos~823 tokens
    Auto-check passed

  • SPARC Development Methodology

    ruvnet/ruflo

    Applies the SPARC method (specification, pseudocode, architecture, refinement, completion) with 17 specialized modes and multi-agent orchestration, from research to deployment.

    74k GitHub starsUsed in 2 repos~829 tokens
    Auto-check passed

  • Swarm Orchestration

    ruvnet/ruflo

    Coordinates a hierarchical swarm of specialized agents through the claude-flow CLI for work that spans several files or modules at once.

    74k GitHub starsUsed in 2 repos~779 tokens
    Auto-check passed

  • Ruflo Multi-Agent Orchestration

    ruvnet/ruflo

    Sets up and drives Ruflo, an npm-installed orchestration layer for multi-agent swarms, persistent memory, routing, hooks and its MCP tool catalog.

    74k GitHub starsUsed in 1 repo~975 tokens
    Auto-check passed

  • Agent Coordination

    ruvnet/ruflo

    Reference for spawning, listing, monitoring and stopping agents with claude-flow commands, with agent type families, routing codes and coordination tips.

    74k GitHub starsUsed in 2 repos~519 tokens
    Auto-check passed

Works with

Categories

Questions about API Docs

What does API Docs do?

Generate API documentation from source code with JSDoc and OpenAPI support. API Docs is an agent skill from ruvnet/ruflo.

When should I use API Docs?

API Docs fits situations like: tasks that involve Technical documentation; tasks that involve OpenAPI specifications.

How do I install API Docs in Claude Code?

Run `npx skills add ruvnet/ruflo --skill api-docs -a claude-code`. Or copy the skill folder (plugins/ruflo-docs/skills/api-docs in ruvnet/ruflo) into .claude/skills/api-docs in your project. Claude Code loads it when a task matches its description.

How do I install API Docs in Codex?

Run `npx skills add ruvnet/ruflo --skill api-docs -a codex`. Or copy the skill folder (plugins/ruflo-docs/skills/api-docs in ruvnet/ruflo) into .agents/skills/api-docs in your project. Codex loads it when a task matches its description.

Can I use API Docs in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add ruvnet/ruflo --skill api-docs -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/api-docs, .gemini/skills/api-docs, .github/skills/api-docs and .opencode/skills/api-docs in your project.

What does API Docs need to run?

SKILL.md names no scripts, command-line tools or credentials: API Docs is instructions for the agent only. Our summary lists: Node.js. Its frontmatter pre-approves these tools: Bash(npx *), mcp__plugin_ruflo-core_ruflo__hooks_worker-dispatch, Read, Write, Grep.

Does API Docs access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is API Docs safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does API Docs use?

API Docs is published under the MIT licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does API Docs use?

About 239 tokens (SKILL.md is roughly 956 characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to API Docs?

Skills that share tags, products or a category with API Docs: Nacos API Doc Update (nacos-group/nacos-group.github.io, 115 stars), API Documentation Generator (luongnv89/claude-howto, 42k stars), Dashclaw Ship (ucsandman/DashClaw, 310 stars) and Agentic Workflows API Documentation Lungo (agntcy/coffeeAgntcy, 112 stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains API Docs?

ruvnet (a GitHub user) maintains it in ruvnet/ruflo, which has 74,012 GitHub stars. The repository holds 264 skills in this directory. The repository was last updated on October 7, 2026.

Source: ruvnet/ruflo on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.