Devdocs MCP

🚀 DevDocs-MCP: AIエージェント向けの公式ドキュメント

ローカルでバージョン管理が可能な信頼性の高いドキュメントを提供し、AIの幻覚を解消します。

DevDocs-MCPは、Model Context Protocol (MCP) サーバーです。DevDocs.io から取得したバージョン固定の決定論的なドキュメントを、AIアシスタント（Claude、RooCode、Cline、Copilotなど）に提供します。これはローカルのドキュメントインテリジェンスレイヤーとして機能し、エージェントが常に正しいAPIコンテキストを持ち、ネットワークの遅延やトレーニングデータのずれを心配する必要がありません。

このサーバーは、MCP で定義された提案されたMCPサーバー標準に従っています。この標準は、Anthropic、OpenAI、GoogleなどのプロバイダーのAIツールやエージェントを含むエコシステム全体で採用されています。

⚠️ プロジェクトの状態に関する通知 ⚠️ このプロジェクトは活発に開発中です。既存の機能のテストや、最適なキャッシュ、最新のドキュメントの自動更新やリクエストベースの更新、最適なクエリなどの新機能の実装が必要です。設計決定、API、構造は、開発者コミュニティからの意見、レビュー、フィードバックに基づいて進化することが予想されます。このプロジェクトを正しい方向に導くための議論、批判、貢献を歓迎します。

📑 目次

1. 概要
2. 主要機能
3. クイックスタート
4. インストールとセットアップ
5. AIエージェントの設定
6. 関連資料

🎯 概要

graph TD
    Agent["AIエージェント"] -->|MCP検索/説明| Server["DevDocs-MCPサーバー"]
    Server -->|メタデータ| DB[(SQLite - sql.js)]
    Server -->|内容| FS[ローカルディスク - JSONキャッシュ]
    Server -.->|遅延取得| Web[DevDocs.io API]

✨ 主要機能

• オフラインファースト：ドキュメントはローカルにキャッシュされ、取り込み後はインターネットが不要です。
• ランク付きファジー検索：関連するエントリを即座に見つけることができます（例：「intersection observer」）。
• バージョン認識：プロジェクト内の特定のライブラリのバージョンに自動的にマッピングされます。
• Nodeのみのアーキテクチャ：sql.js を使用して、ネイティブ依存関係がなく（Python/C++のビルド手順が不要）。
• 構造化された出力：クリーンでLLMに最適化された内容を返します。

🚀 クイックスタート

1. クローンとインストール

git clone https://github.com/madhan-g-p/DevDocs-MCP.git
cd DevDocs-MCP
pnpm install

2. 環境の設定

cp .env.example .env
# .envを編集: DEVDOCS_DATA_PATHをドキュメントを保存したい場所に設定します。

3. ビルドと実行

pnpm build
pnpm start:prod

注意：開発と貢献には必ず pnpm を使用してください。

📦 インストールとセットアップ

DevDocs-MCPは、pnpm を使用したスムーズなセットアップに最適化されています。これはNodeのみのプロジェクトです。

前提条件

• Node.js 18+（18.xと20.xでテスト済み）。

🐳 Dockerの使用

DevDocs-MCPは、軽量で永続的に動作するように設計されています。大量のドキュメントデータセットをダウンロードしてキャッシュするため、データボリュームを正しく管理することが重要です。

方法A: Docker Compose（動的かつ永続的）

これが推奨される方法です。.env ファイルの DEVDOCS_VOLUME_SOURCE 変数を使用して、3つのストレージモードをサポートします。

1. 好みのストレージを .env で設定します：

   # モード1: 名前付きボリューム（デフォルト - Dockerが管理）
   DEVDOCS_VOLUME_SOURCE=devdocs_data
   
   # モード2: ホストパス（Docker外 - ローカルフォルダ）
   # DEVDOCS_VOLUME_SOURCE=./my-docs-storage
   

2. サーバーを起動します：

   docker compose up -d
   

柔軟性：コンテナを起動するたびに、.env ファイルの DEVDOCS_VOLUME_SOURCE を変更するだけで、新しいボリューム（新規開始）または既存のボリューム（データを保持）を指定できます。mcp.db（データベースライブラリ）と data/（ドキュメントのダウンロード）はどちらもこのボリューム内に保存されます。

方法B: Docker Run（手動）

Docker Hubから公開イメージを直接実行したい場合は、以下のコマンドを使用します。

docker run -d -p 3000:3000 \
  -v "devdocs_data:/app/data" \
  --name devdocs-mcp \
  madhandock1/devdocs-mcp:latest

💾 データ戦略

このプロジェクトは /app/data の単一のマウントポイントを使用しており、以下の内容が含まれています。

• /app/data/mcp.db：SQLiteレジストリ。
• /app/data/docs/：キャッシュされたドキュメントファイル。 この統一された構造により、1つのフォルダまたはボリュームを移動するだけで、ドキュメントの権限全体を簡単にバックアップまたは移動できます。

設定 (.env)

ドキュメントの取り込み

サーバーがエージェントに接続されたら、ingest ツールを使用して、特定のスタックのドキュメントをダウンロードします。 サーバーが起動して実行されると、エージェントがこれを処理し、利用可能なツールをリストし、それに応じて決定を行います。

{
  "dependencies": {
    "react": "18.2.0",
    "typescript": "5.0.0"
  }
}

注意: 取り込みに使用するDevdocsのフェッチURLは、src/config/constants.ts で定義されています。このURLは現在、正しく公式にサポートされているパスを指しています。将来、devdocs コミュニティがこのパスを変更した場合、設定を適宜更新する必要があります。
このアプローチはウェブスクレイピングを含みません。DevDocsがオフラインで使用するためのドキュメントを提供するために使用する同じサポートされたメカニズムに従っています。

🤖 AIエージェントの設定

RooCode / Cline / Claude Desktop（推奨: STDIO）

mcp_settings.json に以下を追加します。cwd（カレントワーキングディレクトリ）を設定することで、サーバーは .env ファイルから設定を自動的に読み込み、データストレージに相対パスを使用できます。

{
  "mcpServers": {
    "devdocs": {
      "command": "node",
      "args": ["dist/main.js"],
      "cwd": "file://path/to/your/DevDocs-MCP"
    }
  }
}

プロのヒント：cwd にプロジェクトの絶対パスを使用してください。サーバーは .env を見つけ、そこで定義された DEVDOCS_DATA_PATH と MCP_DB_PATH（例：./data または mcp.db）を使用します。これにより、セットアップがポータブルになります！

リモート/ウェブクライアント（HTTP SSE）

サーバーをポート経由で公開する必要がある場合（本番環境/リモート設定）：

1. ポートフラグを指定してサーバーを起動します：

   node dist/main.js --port 3000
   

2. クライアントを設定します：
   • SSE URL：http://your-server:3000/mcp/sse
   • タイプ：SSE（ほとんどのMCPクライアントでサポートされています）

📚 関連資料

• ：データフロー、スキーマ、sql.js の内部構造を詳しく調べます。
• ：ワークフロー、コーディング標準、PRの要件。
• ：MITライセンス。

このプロジェクトは、@Nathaniel Whiteinge による devdocs-local と devdocs-local-demo から着想を得ています。