Skip to main content

api-docs

Generate API documentation from source code with JSDoc and OpenAPI support

ソース情報

リポジトリ
ruvnet/ruflo
ソースの最終更新活動
2026年7月17日 03:06
検出された SKILL.md の言語
英語
スター
73,469
フォーク
8,725

インストール方法

デフォルトでは、最初にソースを確認する Prompt が選択されています。直接コマンドに切り替えるか、ローカルコピーをダウンロードすることもできます。

ソースファイルを確認

インストールを決める前に、SKILL.md と SkillsMP に表示されている付属ファイルをお読みください。

SKILL.md を表示中

SKILL.md
ソースの指示 · 読み取り専用プレビュー
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", 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
GitHubで見る