Mcpdocserver

🚀 MCP サーバープロジェクトドキュメント

このプロジェクトは、MCP サーバーの構築、運用に関する包括的なドキュメントを提供します。サーバーのインストール、ドキュメントの管理、クローラー機能の利用など、様々な機能をサポートしています。

🚀 クイックスタート

このセクションでは、MCP サーバーを迅速にセットアップして起動する手順を説明します。

インストール手順

1. リポジトリをローカルにクローンします。

   git clone https://github.com/your-username/mcp-server.git
   cd mcp-server
   

2. 依存関係をインストールします。

   npm install
   

3. サーバーを起動します。

   node server.js
   

プロジェクト構造

mcp-server/
├── server.js          # メインサーバーファイル
├── docs/             # ドキュメント保管ディレクトリ
│   └── doc.json      # サンプルドキュメントファイル
├── crawl/            # クローラー関連モジュール
│   ├── crawler.js    # クローラーのメインロジック
│   └── parsers/      # データ解析モジュール
├── tools/            # MCP ツールの実装
│   ├── search_docs.js  # ドキュメント検索ツール
│   └── get_doc_detail.js  # ドキュメント詳細取得ツール
└── test/             # テストケース
    └── test_server.js     # サーバーのテストケース

📦 インストール

ドキュメント形式

ドキュメント構造

ドキュメントファイルは JSON 形式で、以下のフィールドを含む必要があります。

{
  "source": {
    "name": "taro",
    "url": "https://docs.taro.zone/docs"
  },
  "lastUpdated": "2024-03-27T12:00:00Z",
  "pages": {
    "https://docs.taro.zone/docs/components-desc": {
      "title": "コンポーネントライブラリの説明 | Taro ドキュメント",
      "content": "ページ内容..."
    },
    // その他のページ...
  }
}

読み込みプロセス

1. サーバー起動時に、docs ディレクトリ内の JSON ファイルが自動的に検出されて読み込まれます。
2. プロジェクトディレクトリ内にドキュメントが見つからない場合、現在の作業ディレクトリから読み込みを試みます。
3. ページ ID はデフォルトで URL をキーとして使用するため、url フィールドを追加で指定する必要はありません。
4. すべてのソース名は、一貫性を保つために自動的に小文字に変換されます。

✨ 主な機能

クローラー機能

システムには組み込みのクローラーがあり、さまざまなフレームワークの公式ドキュメントサイトからコンテンツを取得し、ローカルで使用可能なドキュメント形式に変換することができます。クローラーの特徴は以下の通りです。

1. 多サイト対応：任意のフレームワークやライブラリのドキュメントサイトをサポートし、完全に設定可能です。
2. 選択的クロール：含めるパターンと除外するパターンを設定して、クロールする内容を正確に制御できます。
3. スマートなコンテンツ抽出：ドキュメントページのタイトル、本文コンテンツ、構造を自動的に識別します。
4. マルチスレッドクロール：高い並列性でクロールをサポートし、効率を向上させます。
5. 自動変換：クロールしたコンテンツを標準のドキュメント JSON 形式に変換します。
6. エラー処理機能：タイムアウト処理とリトライ機構を提供し、安定性を高めます。

MCP ツール

サーバーは以下の MCP ツールを提供します。

1. search_docs - ドキュメント検索

• パラメータ:
  • query: 検索キーワード (文字列, 必須)
  • source: ドキュメントソース名 (文字列, オプション)
  • limit: 最大結果数 (数値, オプション, デフォルトは10)
• 特殊機能:
  • query が "reload" の場合、ドキュメントの再読み込みがトリガーされます。

2. get_doc_detail - ドキュメント詳細取得

• パラメータ:
  • id: ドキュメント ID (文字列, 必須)
  • source: ドキュメントソース名 (文字列, オプション)

💻 使用例

基本的な使用法

// ドキュメント検索の例
{
  "command": "search_docs",
  "params": {
    "query": "コンポーネント開発ガイド",
    "source": "taro"
  }
}

// ドキュメント詳細取得の例
{
  "command": "get_doc_detail",
  "params": {
    "id": "https://docs.taro.zone/docs/components-desc"
  }
}

高度な使用法

Cursor での設定方法を説明します。

設定手順

1. サーバーを起動し、その IP アドレスとポート番号を取得します。
2. Cursor でリモートサーバー接続を設定します。

   {
     "name": "mcp-server",
     "type": "http",
     "url": "http://localhost:3000"
   }
   

3. MCP ツールを使用してドキュメントの管理と検索を行います。

📚 ドキュメント

テスト方法

テスト手順

1. サーバーを起動します。

   node server.js
   

2. テストケースを実行します。

   npm test
   

サンプルテストコード

test('search_docs should return results', async () => {
  const response = await fetch('/api/search_docs?query=test');
  expect(response.status).toBe(200);
});

test('get_doc_detail should return details', async () => {
  const response = await fetch('/api/get_doc_detail?id=document-id');
  expect(response.status).toBe(200);
});

よくある質問

1. クローラーの反クロール機構をどのように処理するか？

• リクエスト間隔とランダムなユーザーエージェントを使用して、実際のユーザー行動を模倣します。
• キャプチャや動的なコンテンツの読み込みを処理します。

2. 検索効率をどのように向上させるか？

• 全文インデックス技術（Elasticsearch など）を使用します。
• クエリロジックと結果の並べ替えアルゴリズムを最適化します。

📄 ライセンス

本プロジェクトはオープンソースで、貢献を歓迎しています！

• 問題を報告したり、提案をする場合は、issue を提出してください。
• 機能の改善やバグの修正にコードを貢献してください。