docs

mcp-docs-tools

Model Context Protocol（MCP）経由で提供される、AI エージェント向けのドキュメント生成ツールです。

概要

mcp-docs-tools は、MCP 経由で利用できる、ドキュメント作成に特化した 5 つのツールを提供します。

ツール	説明
generate_jsdoc	関数シグネチャから JSDoc/TSDoc コメントを生成します
analyze_readme	README の完全性を分析し、改善案を提案します
generate_changelog	コミットメッセージから CHANGELOG のエントリーを生成します
generate_api_docs	エンドポイント定義から REST API ドキュメントを生成します
analyze_code_comments	コメントのカバレッジを分析し、TODO を検出して、ドキュメント化されていない関数を特定します

インストール

npm install
npm run build

使用方法

MCP サーバーとして

MCP クライアントの設定に追加します。

{
  "mcpServers": {
    "docs-tools": {
      "command": "node",
      "args": ["path/to/mcp-docs-tools/dist/index.js"]
    }
  }
}

ツール

generate_jsdoc

関数シグネチャを解析し、@param、@returns、@throws、@example タグを含む JSDoc/TSDoc を生成します。

パラメーター：

• functionSignature（string、必須） - ドキュメント化する関数シグネチャ
• description（string、任意） - 関数の説明
• includeExample（boolean、任意、デフォルト：true） - @example タグを含めるかどうか

analyze_readme

README の内容を分析して、必須セクション（Installation、Usage、License など）の有無を確認し、完全性を 0～100 で評価して、不足しているセクションを提案します。

パラメーター：

• content（string、必須） - README ファイルの全文

generate_changelog

Keep a Changelog 形式に従い、Git 形式のコミットメッセージから CHANGELOG のエントリーを生成します。コミットを Added、Changed、Fixed、Removed、Deprecated、Security に分類します。

パラメーター：

• versions（array、必須） - { version, date, commits } オブジェクトの配列
• projectName（string、任意） - ヘッダーに表示するプロジェクト名

generate_api_docs

メソッド、URL、パラメーター、リクエスト／レスポンスの例、ステータスコードなどのエンドポイントの説明から、REST API ドキュメントを Markdown 形式で生成します。

パラメーター：

• apiTitle（string、必須） - API ドキュメントのタイトル
• baseUrl（string、任意） - API のベース URL
• apiDescription（string、任意） - API の概要
• endpoints（array、必須） - エンドポイント定義の配列

analyze_code_comments

ソースコードのコメントカバレッジを分析します。コメントとコードの比率を計算し、TODO/FIXME/HACK マーカーを検出して、ドキュメント化されていない関数を特定し、ドキュメントが必要な箇所を提案します。

パラメーター：

• code（string、必須） - 分析するソースコード
• language（string、任意、デフォルト："typescript"） - プログラミング言語

設定

追加の設定は必要ありません。サーバーは標準入出力経由で動作します。

ライセンス

MIT