Skip to main content
AI/MLruvnet

api-docs

Generate API documentation from source code with JSDoc and OpenAPI support

Stars
56,726
Source
ruvnet/claude-flow
Updated
2026-05-31
Slug
ruvnet--claude-flow--api-docs
View on GitHubRaw SKILL.md

// install — copy + paste into any project

mkdir -p .claude/skills && curl -fsSL https://raw.githubusercontent.com/ruvnet/claude-flow/HEAD/plugins/ruflo-docs/skills/api-docs/SKILL.md -o .claude/skills/api-docs.md

Drops the SKILL.md into .claude/skills/api-docs.md. Works with Claude Code, Cursor, and any agent that loads SKILL.md files from .claude/skills/.

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__claude-flow__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