How to install api-docs
npx skills add https://github.com/ruvnet/ruflo --skill api-docsClaude Code
Cursor
Windsurf
Cline
Full instructions (SKILL.md)
Source of truth, from ruvnet/ruflo.
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
Related skills
More from ruvnet/ruflo and the wider catalog.
CL
claims
ruvnet/ruflo
>
860 installs
CR
cron-schedule
ruvnet/ruflo
Schedule persistent background workers via CronCreate
667 installsAudited
DE
deep-research
ruvnet/ruflo
Orchestrate multi-phase deep research with web search, memory retrieval, pattern matching, and synthesis into structured findings
656 installs
EM
embeddings
ruvnet/ruflo
>
904 installsAudited
FL
flow-nexus-neural
ruvnet/ruflo
Train and deploy neural networks in distributed E2B sandboxes with Flow Nexus
863 installs
FL
flow-nexus-platform
ruvnet/ruflo
Comprehensive Flow Nexus platform management - authentication, sandboxes, app deployment, payments, and challenges
858 installs