Agent skill · Backend & API

api-docs

Generate API documentation from source code with JSDoc and OpenAPI support

rUv71,307★ · +1,002/wk · 3 repos on radarProfile →
claude-codecodexcan modify filesMIT
Install
npx skills add ruvnet/ruflo --skill api-docs --agent claude-code

Same command for any agent — swap --agent for codex, cursor, copilot.

Facts
Files in the skill folder: 1
SKILL.md size: 1 KB
Bundled scripts: none
Allowed tools: Bash(npx*)mcp__plugin_ruflo-core_ruflo__hooks_worker-dispatchReadWriteGrep
Path: plugins/ruflo-docs/skills/api-docs/SKILL.md
Open the folder on GitHub →
Where it comes from
Source: ruvnet/ruflo
Stars: 67,015 · +629 this week
Language: TypeScript
Read our review of the source →

Weekly change comes from our own snapshots, not the repository page — it measures attention, not adoption.

From the SKILL.md

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

More from ruflo
All skills →
About this skill
What does the api-docs skill do?

Generate API documentation from source code with JSDoc and OpenAPI support

How do I install it?

Run `npx skills add ruvnet/ruflo --skill api-docs --agent claude-code` — it drops the skill into your project so the agent can pick it up. Swap the --agent value for codex, cursor or copilot if you use one of those.

Where does this skill come from?

From ruvnet/ruflo, a repository with 67,015 stars. We read it straight from the repository tree rather than a submitted listing, so what you see here is what is actually published.

Is a popular skill a good skill?

Not necessarily. Stars measure attention, not adoption — a repository can trend for a week and be abandoned. That is why we show the weekly change from our own snapshots next to the total, instead of a single flattering number.

Keep going