Documentation MCP Server

Documentation MCP Server

開発者が好みのライブラリの最新ドキュメントにアクセスするためのサーバーです。

概要

この MCP（Model-Controller-Presenter）サーバーは、さまざまなライブラリのドキュメントにアクセスするための統一インターフェースを提供します。複数のソースからドキュメントを集約し、すべてのライブラリを横断した検索を可能にするとともに、開発者が常に最新の情報を利用できるようにします。

機能

• ドキュメントの集約：さまざまなライブラリのソースからドキュメントを収集します
• 検索機能：すべてのライブラリを横断して検索したり、特定のライブラリで絞り込んだりできます
• バージョン管理：ライブラリのさまざまなバージョンのドキュメントにアクセスできます
• 自動更新：最新のドキュメントを定期的に取得します
• API アクセス：API を通じて、ドキュメントにプログラムからアクセスできます
• インタラクティブ UI：ドキュメントを閲覧するための Web インターフェース

クイックインストール

インストールスクリプトを使用する

最も簡単な方法です。

# Clone the repository
git clone https://github.com/SubaashNair/documentation-mcp-server.git
cd documentation-mcp-server

# Make the installation script executable
chmod +x install.sh

# Run the installation script
./install.sh

Docker を使用する

# Clone the repository
git clone https://github.com/SubaashNair/documentation-mcp-server.git
cd documentation-mcp-server

# Copy and edit environment variables
cp .env.example .env

# Start with Docker Compose
docker-compose up -d

手動インストール

詳しいインストール手順については、インストールガイドを参照してください。

使用方法

Web インターフェース

ブラウザーで http://localhost:3000 にアクセスすると、Web インターフェースを利用できます。

API の使用方法

このサーバーは、ドキュメントにプログラムからアクセスするための RESTful API を提供します。

例：ドキュメントを検索する

curl -X GET "http://localhost:3000/api/search?q=useState&library=react"

例：ライブラリのドキュメントを取得する

curl -X GET "http://localhost:3000/api/libraries/react/hooks/useState"

例：API のステータスを取得する

curl -X GET "http://localhost:3000/api/status"

API ドキュメントの全容については、サーバー上の /api-docs（例：http://localhost:3000/api-docs）にアクセスしてください。

アーキテクチャ

Documentation MCP Server は Model-Controller-Presenter（MCP）パターンに従っています。

• モデル：ドキュメントを取得および保存するデータサービス（src/services/）
• コントローラー：API エンドポイントのリクエストハンドラー（src/controllers/）
• プレゼンター：フロントエンドのインターフェースと API レスポンスのフォーマット（public/）

設定

.env ファイルを編集するか、環境変数を設定してサーバーを構成できます。

基本設定

変数	説明	デフォルト
PORT	サーバーを実行するポート	3000
GITHUB_TOKEN	API アクセス用の GitHub トークン	-
DOCUMENTATION_UPDATE_SCHEDULE	更新用の Cron スケジュール	0 0 * * *（毎日）
LIBRARIES	取得するライブラリをカンマ区切りで指定したリスト	react,vue,angular

設定オプションの全容については、インストールガイドを参照してください。

新しいライブラリの追加

ドキュメントサーバーに新しいライブラリを追加するには、次の手順に従います。

1. 既存のライブラリの形式に沿って、src/libraries/ に新しいファイルを作成します
2. ドキュメントを取得して解析するために必要なインターフェースを実装します
3. 設定にライブラリを追加します

実装例：

// src/libraries/your-library.js
const fetchYourLibraryDocumentation = async (version) => {
  // Implementation for fetching documentation
  // ...
};

module.exports = {
  fetchDocumentation: fetchYourLibraryDocumentation
};

次に、.env ファイルに追加します。

LIBRARIES=react,vue,angular,your-library

ドキュメント

• インストールガイド - 詳しいセットアップ手順
• API ドキュメント - OpenAPI ドキュメント（サーバー実行中）
• コントリビューションガイドライン - プロジェクトへの貢献方法

ロードマップ

• 対応するライブラリを追加（TypeScript、Node.js など）
• ユーザーアカウントとお気に入り機能を実装
• オフラインでのドキュメント利用に対応
• ドキュメントにアクセスするための CLI ツールを作成
• ドキュメントへのコミュニティからの貢献を実装

貢献

皆さまからの貢献を歓迎します！お気軽にプルリクエストを送信してください。

1. リポジトリをフォークします
2. フィーチャーブランチを作成します（git checkout -b feature/amazing-feature）
3. 変更をコミットします（git commit -m 'Add some amazing feature'）
4. ブランチにプッシュします（git push origin feature/amazing-feature）
5. プルリクエストを作成します

ライセンス

このプロジェクトは MIT ライセンスの下でライセンスされています。詳細は LICENSE ファイルをご覧ください。

謝辞

• ドキュメントと API の設計は DevDocs に着想を得ています
• アーキテクチャパターンは Express.js を参考にしています
• 検索機能は Lunr.js を利用しています