MCP Server Documentation

🚀 MCP ドキュメント検索サーバー

このサーバーは、FastMCP を用いて構築された強力なドキュメント検索サーバーです。AI システムが複数の人気フレームワークやライブラリのドキュメントをスマートに検索できるようにし、統一インターフェースを通じて関連情報を迅速にアクセスおよび取得できるようにします。

🚀 クイックスタート

インストール要件

• オペレーティングシステム：Unix、Linux、macOS がサポートされています。Windows では追加の設定が必要です。
• Python バージョン：3.8 以上が必要です。
• パッケージ管理ツール：pip または uv パッケージマネージャーの使用をおすすめします。
• 依存関係：requests ライブラリをインストールする必要があります。

サーバーの起動手順

1. コードリポジトリをクローンします：

   git clone https://github.com/your-repository.git
   cd mcp-docs-search-server
   

2. 仮想環境を設定します（推奨）：

   python -m venv env
   source env/bin/activate  # Unix/Linux の場合
   # または
   .\env\Scripts\activate  # Windows の場合
   

3. 依存関係をインストールします：

   pip install -r requirements.txt
   

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

   python server.py
   

✨ 主な機能

• 📚 多ライブラリサポート：複数のライブラリのドキュメントを検索できます。
  • LangChain - JavaScript/TypeScript の LangChain ドキュメント
  • LangGraph - LangGraph.js のドキュメント
  • Next.js - Next.js フレームワークのドキュメント
  • Tailwind CSS - ユーティリティファーストの CSS フレームワーク
  • FastMCP - FastMCP のドキュメント
  • Framer Motion - React のアニメーションライブラリ
• 🔍 スマート検索
  • ライブラリ名のバリエーションをスマートに処理します。
  • 高精度の DuckDuckGo 検索結果を提供します。
  • サイト固有の検索機能があります。
• ⚡ パフォーマンス最適化
  • 非同期処理を行います。
  • 効率的なウェブリクエスト処理を行います。
  • 並列リソースロードをサポートします。
• 🛡️ エラー処理
  • 自動リトライ機構があります。
  • タイムアウト制御を行います。
  • ステータスコードの検証を行います。

💻 使用例

基本的な使用法

from mcp_search import search_document

# Framer Motion のドキュメントを検索
results = search_document("framer motion", "animations")
print(results)

# Tailwind CSS のドキュメントを検索
results = search_document("tailwind css", "utilities classes")
print(results)

📋 テストガイド

単体テスト

pytest tests/

統合テスト

PYTEST_ARGS="-v" pytest integration_tests/

非同期テスト

uvicorn async_server:app --reload

🗄 プロジェクト構造

• mcp_search/：核心的な検索モジュールです。
• server.py：メインのサーバーファイルです。
• requirements.txt：依存関係の管理ファイルです。
• tests/：単体テストのディレクトリです。

🛠️ 設定ガイド

サポートされるライブラリ

config.py でドキュメントの URL を定義します：

DOCS_URLS = {
    "new-library": "https://docs.new-library.com",
    # 既存のエントリ...
}

エイリアスを追加します：

LIBRARY_ALIASES = {
    "new-lib": "new-library",
    # 既存のエントリ...
}

ネットワーク設定

config.py でタイムアウトと検索結果の数を調整します：

HTTP_TIMEOUT = 30.0        # タイムアウト時間（秒）
MAX_SEARCH_RESULTS = 2     # 取得する結果の数

🤝 コントリビューションガイド

1. リポジトリをフォークします。
2. 機能ブランチを作成します。
3. 変更をコミットします。
4. 新しい機能のテストを追加します。
5. すべてのテストが通過することを確認します。
6. プルリクエストを送信します。

新しいライブラリの追加手順

1. DOCS_URLS と LIBRARY_ALIASES を更新します。
2. 統合テストを行います。
3. ドキュメントを更新します。

🚨 トラブルシューティング

• タイムアウトエラー：HTTP_TIMEOUT の値を増やしてください。
• 結果が得られない場合：異なる検索キーワードを試してみるか、ライブラリ名を確認してください。
• ネットワークエラー：インターネット接続とドキュメントの URL を確認してください。

📄 ライセンス

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

🙏 謝辞

以下のプロジェクトと技術に感謝します。

• FastMCP：核心的な機能を提供してくれました。
• DuckDuckGo：検索サポートを提供してくれました。
• pytest：テストフレームワークを提供してくれました。