Api Docs
Generate API documentation from source code with JSDoc and OpenAPI support
by ruvnet · MIT
The skill
Generate API documentation from source code with JSDoc and OpenAPI support
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", context: "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
Use this skill
Connect your agent to the Skill Store MCP server and ask for it by ref: ruvnet/api-docs-57567490684.
Details
- Publisher
- ruvnet
- Category
- Software Development › Developer docs & tooling
- License
- MIT
- Updated
- 2026-10-18
References
More from ruvnet
- Agent Adaptive Coordinator Coordinates swarm topology switching between hierarchical, mesh, ring and hybrid patterns using clau
- Agent Agent Goal-oriented action planning (GOAP) for multi-step objectives: models world state as preconditions
- Agent Agentic Payments Manages autonomous AI agent payments through the agentic-payments MCP server: creates and revokes Ac
- Agent Analyze Code Quality This skill analyzes source code in JavaScript, TypeScript, Python, Java, and Go files for quality is