ruvnet/ruflo1 file

API Docs

Generate API documentation from source code with JSDoc and OpenAPI support

Specification
Skill ID
ruvnet/ruflo/api-docs
Publisher
ruvnet
Repository
ruflo
Installs
0
Files
1
Synced
Sep 23, 2026
How to use it

Open any RiverX project, open the Skills panel in the chat, and search for this identifier. The files are fetched from the source repository at install time.

ruvnet/ruflo/api-docsInstalls these files
  • SKILL.md

What this skill tells the agent

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

Use this skill in a project

Open any RiverX project, search the Skills panel for ruvnet/ruflo/api-docs, and install it in one click.

Use this skill