Skip to main content
affpapa.org
RU EN
skill Claude Code CX Codex Cursor GitHub Copilot

api-docs — Claude Code skill: what it does, how to install

Skill that turns TypeScript and JavaScript source into documentation: it finds public exports, reads existing JSDoc, writes the missing comments and emits OpenAPI 3.0 for HTTP endpoints.

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓ 
npx skills add ruvnet/ruflo --skill api-docs -a claude-code
Open on GitHub

What api-docs does

The skill walks a TypeScript or JavaScript source tree and collects the public surface: functions, classes, interfaces. Then it reads the JSDoc already in the code (@param, @returns, @throws, @example) and fills in what is missing. HTTP endpoints get a separate pass that produces OpenAPI 3.0 definitions.

Four steps: scan exports, parse JSDoc, generate the gaps, build the spec. The conventions are strict. Every public export must carry a comment, @param and @returns need a type and a description, known error conditions go into @throws, and non-obvious usage gets an @example. Document things differently in your codebase and the skill will rewrite files to match its own style.

The source path is passed as the argument. Dispatch runs through the MCP tool mcp__plugin_ruflo-core_ruflo__hooks_worker-dispatch with the document trigger, and npx * is the only Bash command allowed. No connected MCP server means that step never fires, so check it first when a run looks stuck.

What it helps with

  • map every public export in an unfamiliar package
  • write JSDoc for functions that have none
  • turn existing HTTP routes into an OpenAPI 3.0 spec
  • verify that @param and @returns carry a type and a description
  • document thrown errors and non-obvious usage examples

Example prompts for the agent

  • Run api-docs on `src/api` and list the exports that have no JSDoc.
  • Generate an OpenAPI 3.0 spec for the HTTP endpoints under `src/routes`.
  • Add `@throws` to every function in `packages/core/src` that can throw.

How to install api-docs

1Skills CLI (Vercel)

npx skills add ruvnet/ruflo --skill api-docs -a claude-code

2Manually: put the files in place

~/.claude/skills/api-docs/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/api-docs/

From the same set104

The whole set →
ruflo ruvnet This skill adds multi-agent orchestration, memory, routing, and MCP tools to a project. Use it for swarm tasks and multi-step workflows. Claude Code CX Codex Cursor +1 4,000installs Swarm Orchestration ruvnet Skill for managing agent swarms with parallel execution, dynamic topology, and automatic load balancing. Use when a single agent is not enough and you need to orchestrate specialists of different types. Claude Code CX Codex Cursor +1 2,100installs github-project-management ruvnet Turns issue triage and board upkeep into gh and ruv-swarm calls: labels, subtasks, duplicate lookup. Useful when the tracker holds more tickets than order. Claude Code CX Codex Cursor +1 1,400installs github-workflow-automation ruvnet Automates GitHub Actions with AI agent coordination. Generates optimised pipelines, manages pull requests, analyzes failed runs, and deploys updates with risk assessment. Claude Code CX Codex Cursor +1 1,300installs github-code-review ruvnet Runs a swarm of specialized AI agents to inspect GitHub pull requests for security, performance, and architecture issues. Claude Code CX Codex Cursor +1 1,300installs stream-chain ruvnet Chains sequential agent steps together using streaming JSON flow and provides ready-to-run pipelines. Claude Code CX Codex Cursor +1 1,200installs flow-nexus-swarm ruvnet Deploy cloud-based AI agent swarms and define event-driven workflows with message queues. Use it to coordinate tasks, inspect runs, and scale a swarm. Claude Code CX Codex Cursor +1 1,200installs performance-analysis ruvnet Detects bottlenecks in Claude Flow swarms, profiles agent operations, and generates reports with actionable optimization recommendations. Claude Code CX Codex Cursor +1 1,200installs

Similar

pptx-slide-specification kimtth A skill for writing and repairing coordinate-explicit JSON specs of slides, so an editable PPTX deck builds the same way every time. Claude Code CX Codex Cursor 2,600installs dataset-curation Seth Hobson This skill formats and checks datasets for model fine-tuning. Use it to prepare data for SFT or preference training before a run. Claude Code CX Codex Cursor 2,600installs write-pr tldraw Sets PR title and description standards: semantic types, structured templates, and reviewer-focused writing rules. Claude Code CX Codex Cursor +1 419installs prd-development deanpeters Guides you through writing a structured PRD from discovery notes and user research for engineering handoff. Best for major product initiatives. Claude Code CX Codex Cursor +1 4,700installs pptx-quality-gates kimtth Checks and repairs editable PPTX decks for geometry, accessibility, native objects, source lineage, and OOXML package integrity before delivery. Claude Code CX Codex Cursor 2,500installs architect jsmastery-pro Structures architectural discovery and writes build specifications into docs/specs/. It helps choose tech stacks and design features before writing any code. Claude Code CX Codex Cursor +1 6,800installs grill-with-docs Matt Pocock This skill interviews you about a plan or design and creates ADRs and a glossary along the way. Use it when decisions need sharper definition. Claude Code 1,219,756installs skill-creator official anthropics Creates and refines skills, then tests them with prompts, evaluations, and performance checks. Claude Code Claude.ai 414,180installs

Questions about api-docs

How do I install api-docs in Claude Code?

Run npx skills add ruvnet/ruflo --skill api-docs -a claude-code. The skill lands at ~/.claude/skills/api-docs/SKILL.md.

What does api-docs do?

It scans exports in TypeScript and JavaScript source, parses the JSDoc annotations already there, adds the missing ones, and generates OpenAPI 3.0 definitions for HTTP endpoints.

What does it need to work?

The dispatch step calls the MCP tool mcp__plugin_ruflo-core_ruflo__hooks_worker-dispatch with the document trigger, so that MCP server has to be connected. The skill itself ships in the ruvnet/ruflo repository under the MIT license.

Source text

SKILL.md · MIT 
---
name: api-docs
description: Generate API documentation from source code with JSDoc and OpenAPI support
argument-hint: "<source-path>"
allowed-tools: Bash(npx *) mcp__plugin_ruflo-core_ruflo__hooks_worker-dispatch Read Write Grep
---
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

© ruvnet · MIT · ruvnet/ruflo

See also

Project sponsors

Companies that keep this analytics open
Gold sponsor
Nutra.Club

Impressions, clicks and code copies — open statistics. We keep the numbers public for the same reason NeBlask itself is public. Become a sponsor