Api Docs

Scans your TypeScript or JavaScript codebase to extract JSDoc comments and generate API documentation, including OpenAPI 3.0 specs for HTTP endpoints. It finds public exports, parses parameter and return type annotations, and can fill in missing documentation where needed. The skill enforces conventions like requiring JSDoc comments on all public APIs and including examples for complex usage. Honestly, this is most useful when you've inherited a codebase with spotty documentation or need to quickly bootstrap API docs from existing code comments. It won't write your documentation strategy for you, but it handles the tedious extraction and formatting work.

skills.sh installs: 893
GitHub stars: 81.4K
last updated: Aug 21, 2026

View on GitHub

Install

$ npx -y skills add ruvnet/ruflo --skill api-docs --agent claude-code

Installs into .claude/skills of the current project.

Files

Generate API documentation from TypeScript/JavaScript source:

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

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

Conventions: