api-docs
Generate API documentation from source code with JSDoc and OpenAPI support
Source facts
- Repository
- ruvnet/ruflo
- Last source activity
- July 17, 2026 at 03:06
- Detected SKILL.md language
- English
- Stars
- 73,469
- Forks
- 8,725
Install options
The review-first prompt is selected by default. You can switch to a direct command or download a local copy.
Review the source files
Read SKILL.md and any companion files shown by SkillsMP before deciding whether to install.
Showing SKILL.md
SKILL.md
Source instructions · Read-only preview- 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
View on GitHub