MCP Server Documentation

🚀 MCP 文檔搜索服務器

MCP 文檔搜索服務器是一個功能強大的工具，它基於 FastMCP 構建，能讓 AI 系統在多個流行框架和庫的文檔間進行智能搜索。通過統一接口，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 測試框架