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:
- 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__plugin_ruflo-core_ruflo__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
Related skills
API Documentation Generator
Documentation
Automatically generates OpenAPI/Swagger API documentation.
Claude CodeCursorCopilotbeginner
340
98
1,620
Technical Writer
Documentation
Writes clear technical documentation following top style guides.
claudeCursorWindsurf+1intermediate
167
48
760
Project Documentation Lookup
Documentation
Quickly find project information in the docs/ folder: state, runbooks, strategies, and references.
Claude CodeCursorWindsurf+2beginner 1
0
0
28