Skip to content
Development
Skill

/api-docs

Generate API documentation from source code with JSDoc and OpenAPI support

From plugin
claude-flow
67k200 skills157 agents194 commands1 MCP
Install
$ npx -y skills add ruvnet/ruflo --skill api-docs --agent claude-code

How it fires

How this skill gets triggered: by you, by Claude, or both.

  • Fires itselfAuto-invocation. Claude auto-loads it when your prompt matches the work.Auto-invocation is when the right skill fires by itself at the right moment, driven by a FLOW.md router and a hook, instead of you invoking it by name. It is the difference between a skill being installed and a skill actually getting used.Read the full definition →
  • You can call itInvoke it directly when you want it.
  • Slash command/api-docs

Context preview

The summary Claude sees to decide when to auto-load this skill.

Generate API documentation from source code with JSDoc and OpenAPI support

SKILL.md

api-docs.SKILL.md
name: api-docs
description: Generate API documentation from source code with JSDoc and OpenAPI support
argument-hint: "<source-path>"
allowed-tools: Bash(npx *) mcp__plugin_ruflo-core_ruflo__hooks_worker-dispatch Read Write Grep

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
Ships withclaude-flow

An agent meta-harness for Claude Code and Codex. Agent = Model + Harness. The model writes; the harness gives it tools, memory, loops, sandboxes, and controls so it can actually work.

Get the whole plugin

Other skills on claude-flow.