ruvnet/ruflo891 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-docsIs this agent skill safe to install?
- Gen Agent Trust Hubpass
The skill processes external source code to generate documentation, which introduces a potential surface for indirect prompt injection via malicious comments or code. It also has the capability to execute commands through npx.
- Socketpass
No alerts
- Snykpass
Risk: LOW · No issues
What does this agent skill do?
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", 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
How can the creator link this skill?
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>