api-docs
Generate API documentation from source code with JSDoc and OpenAPI support
Best for library maintainersWorks with GitHubLow risk
⌘source
- author
@ruvnet- repo
- ruvnet/ruflo
- language
- TypeScript
★46kstars
5.1kforks
May 5, 2026
✦overview.md
Key Features
- ·Scans public exports automatically
- ·Extracts JSDoc annotations
- ·Generates missing JSDoc for undocumented APIs
- ·Creates OpenAPI 3.0 specs for HTTP endpoints
- ·Supports TypeScript and JavaScript
Use Cases
- →Generating API docs for a new TypeScript library
- →Adding OpenAPI spec to an existing Express API
- →Enforcing JSDoc coverage in CI pipeline
- →Documenting a JavaScript SDK for external consumers
Best for
- ✓library maintainers
- ✓API development teams
Not ideal for
- !non-TypeScript/JS projects
- !private internal code
FAQs
name
api-docs
description
Generate API documentation from source code with JSDoc and OpenAPI support
argument-hint:<source-path>
allowed-tools:Bash(npx *) mcp__claude-flow__hooks_worker-dispatch Read Write Grep
Generate API documentation from TypeScript/JavaScript source:
- Scan exports: Find all public functions, classes, and interfaces
- Extract JSDoc: Parse
@param,@returns,@throws,@exampleannotations - Generate missing docs: Add JSDoc for undocumented public APIs
- 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
@paramwith type and description - Include
@returnswith type and description - Include
@throwsfor known error conditions - Include
@examplefor non-obvious usage
$install
1-click copynpx skills add ruvnet/ruflo --skill api-docsSafety assessment
★
Clarity score
How clear and easy to understand the SKILL.md instructions are, rated from 1 to 5.
4/ 5
very goodClear and well structured, with only minor parts that might need a second read.
◎
Actionability score
How directly an agent can act on the SKILL.md instructions, rated from 1 to 5.
4/ 5
highMostly actionable with clear steps; only a few small gaps remain.