skillZs
★ LIVE SKILL TAGS ★
>>> LIVE SKILLS INDEX <<<
* OPEN SOURCE *
NO LOGIN, NO TRACKING
※ REAL INSTALL DATA ※
← back to all skills
ruvnet/ruflo893 installs

api-docs

Generate API documentation from source code with JSDoc and OpenAPI support

How do I install this agent skill?

npx skills add https://github.com/ruvnet/ruflo --skill api-docs
view source ↗

Is this agent skill safe to install?

  • Gen Agent Trust Hubpass

    The skill is functional and safe but contains a surface for indirect prompt injection because it parses untrusted source code and JSDoc comments to generate documentation. If the source files contain malicious instructions in comments, the agent could potentially be tricked into performing unintended file writes or command executions.

  • Socketpass

    No alerts

  • Snykpass

    Risk: LOW · No issues

What does this agent skill do?

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

Add the canonical catalog link to the repository README so users can inspect current installs and available audits. The publishing guide covers the complete discovery path.

<a href="https://skillzs.dev/skills/ruvnet/ruflo/api-docs">View api-docs on skillZs</a>