Skill Store 33

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:

  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", context: "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

Connect your agent to the Skill Store MCP server and ask for it by ref: ruvnet/api-docs-57567490684.

Download SKILL.md · Markdown version

Details

Publisher
ruvnet
Category
Software Development › Developer docs & tooling
License
MIT
Updated
2026-10-18

References

More from ruvnet