mcpField
A
api-docs

api-docs

github.com/ruvnetDevelopment80.0k891 installsUpdated today
Repository

About api-docs

api-docs is a skill for documenting TypeScript and JavaScript APIs. It scans public exports, processes JSDoc, fills documentation gaps, and generates OpenAPI 3.0 definitions for HTTP endpoints.

Key features

  1. 01Scan public functions, classes, and interfaces
  2. 02Parse JSDoc annotations
  3. 03Add missing JSDoc
  4. 04Generate OpenAPI 3.0 definitions

Use cases

  1. 01Document undocumented public exports
  2. 02Produce API references from source code
  3. 03Describe HTTP endpoints with OpenAPI

MCP support

The skill dispatches documentation work through an MCP hook worker with the document trigger and API scope.

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/ruvnet/ruflo --skill api-docs

After installing, type/api-docsin Claude Code to confirm it loaded.

Details

From the project README

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

Comments

Markdown supported