Api Docs
- 790 installs
- 67k repo stars
- Updated August 4, 2026
- ruvnet/ruflo
api-docs is an agent skill that scans TypeScript and JavaScript exports, extracts or generates JSDoc, and produces OpenAPI 3.0 specs so developers who maintain HTTP APIs keep reference documentation synchronized with sou
About
api-docs is a ruflo agent skill that generates accurate API documentation directly from TypeScript and JavaScript source code. The workflow scans public functions, classes, and interfaces, parses existing JSDoc @param, @returns, @throws, and @example tags, fills gaps for undocumented public APIs, and emits OpenAPI 3.0 definitions for HTTP endpoints. It dispatches documentation work via MCP using claude-flow hooks_worker-dispatch with trigger document and scope api. Developers reach for api-docs when OpenAPI specs drift from implementation, when exported functions lack JSDoc, or when they need agent-driven doc generation from a source path argument without manually maintaining separate reference files.
- Automatically generates OpenAPI specs and interactive docs from code
- Extracts endpoint descriptions, parameters, and response schemas
- Produces developer-friendly reference pages and markdown summaries
- Works with agent tools, MCP servers, and REST/HTTP services
- Reduces manual documentation effort by over 80% on typical projects
Api Docs by the numbers
- 790 all-time installs (skills.sh)
- +10 installs in the week ending Jul 26, 2026 (Skillselion tracking)
- Ranked #307 of 1,879 Documentation skills by installs in the Skillselion catalog
- Data as of Aug 5, 2026 (Skillselion catalog sync)
npx skills add https://github.com/ruvnet/ruflo --skill api-docsAdd your badge
Show developers this skill is listed on Skillselion. Paste this into your README.
| Installs | 790 |
|---|---|
| repo stars | ★ 67k |
| Last updated | August 4, 2026 |
| Repository | ruvnet/ruflo ↗ |
How do you generate OpenAPI docs from TypeScript source?
Automatically generate accurate, up-to-date OpenAPI documentation and reference materials from code and agent capabilities.
Who is it for?
Backend developers maintaining TypeScript or JavaScript HTTP APIs who need JSDoc and OpenAPI specs generated automatically from source exports.
Skip if: Teams documenting gRPC-only services, GraphQL schemas without REST endpoints, or APIs with no machine-readable source exports.
When should I use this skill?
User asks to document APIs, generate OpenAPI specs, add JSDoc to exports, or sync reference docs with TypeScript/JavaScript source.
What you get
JSDoc-annotated public APIs, OpenAPI 3.0 endpoint definitions, and up-to-date reference documentation synced to exports.
- OpenAPI 3.0 spec
- JSDoc-annotated source files
By the numbers
- Outputs OpenAPI 3.0 definitions
- Parses four JSDoc tag types: @param, @returns, @throws, @example
Files
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__claude-flow__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
Related skills
Lark MarkdownInstantly turn any markdown file into clean, formatted Lark/Figma-compatible documents without manual reformatting.488k
Lark DocCreate, read, update, summarize, rewrite and manage Feishu/Lark cloud documents directly from agent workflows.401k16.1kLark WikiCreate, organize, query, and manage documents, spaces, and members inside Lark (Feishu) knowledge bases directly from AI agent workflows.397k16.1k
Domain ModelingBuild and sharpen a project's domain model: pin down domain terminology in a glossary and record architectural decisions as ADRs.318k202k
Opensource Guide CoachGet expert, attribution-safe guidance on launching and sustaining an open-source project.270k71Readme I18nMaintain consistent, updatable language selector blocks across every README variant in a multilingual repository.270k71How it compares
Pick api-docs over manual Swagger editing when documentation must stay synchronized with live TypeScript/JavaScript exports and JSDoc annotations.
FAQ
What documentation formats does api-docs produce?
api-docs generates JSDoc annotations for public TypeScript and JavaScript exports and OpenAPI 3.0 definitions for HTTP endpoints. It scans source, parses existing tags, and fills documentation gaps before outputting specs.
How does api-docs integrate with ruflo MCP?
api-docs dispatches documentation tasks through MCP via mcp__claude-flow__hooks_worker-dispatch with trigger set to document and scope set to api, enabling automated doc generation from a specified source path.