MCP Docs Server

🚀 MCP文檔服務器

MCP文檔服務器是一個用於搜索模型上下文協議（MCP）文檔的服務器。它基於官方MCP SDK，使用TypeScript構建。

✨ 主要特性

• BM25搜索：使用帶有Porter詞幹提取的BM25算法進行高質量的排序搜索。
• 快速啟動：在啟動時對文檔標題建立索引，並按需獲取內容。
• 支持Markdown：對標題、代碼塊和鏈接進行加權，以提高搜索相關性。
• 標準輸入輸出傳輸：作為本地進程運行，便於集成。

📦 安裝指南

快速開始（推薦）

將以下配置添加到你的MCP客戶端配置文件（如Claude Desktop、Kiro等）中：

{
  "mcpServers": {
    "mcp-docs-server": {
      "command": "npx",
      "args": ["-y", "@praveenc/mcp-docs-server"]
    }
  }
}

就這麼簡單！服務器將自動下載並運行。

全局安裝

npm install -g @praveenc/mcp-docs-server

然後配置你的MCP客戶端：

{
  "mcpServers": {
    "mcp-docs-server": {
      "command": "mcp-docs-server"
    }
  }
}

💻 使用示例

search_mcp_docs

用於搜索MCP協議文檔並返回排序結果。

參數：

• query（字符串，必填）：搜索查詢字符串。
• k（數字，可選）：返回的最大結果數（默認值：5）。如果匹配的文檔較少，則返回較少的結果。

示例：

{
  "query": "transports",
  "k": 5
}

返回結果：

[
  {
    "url": "https://modelcontextprotocol.io/specification/2025-11-25/basic/transports.md",
    "title": "Transports",
    "score": 15.725,
    "snippet": "MCP uses JSON-RPC to encode messages..."
  }
]

fetch_mcp_doc

根據URL獲取完整的文檔內容。

參數：

• uri（字符串，必填）：來自modelcontextprotocol.io的文檔URL。

示例：

{
  "uri": "https://modelcontextprotocol.io/specification/2025-11-25/server/tools.md"
}

返回結果：

{
  "url": "https://modelcontextprotocol.io/specification/2025-11-25/server/tools.md",
  "title": "Tools",
  "content": "# Tools\n\nTools enable servers to expose executable functionality..."
}

🔧 使用MCP檢查器進行測試

npx @modelcontextprotocol/inspector npx -y @praveenc/mcp-docs-server

🔨 開發

克隆倉庫進行本地開發

git clone https://github.com/praveenc/mcp-docs-server.git
cd mcp-docs-server
npm install

命令

# 以開發模式運行
npm run dev

# 運行測試
npm test

# 類型檢查
npm run typecheck

# 構建
npm run build

# 使用MCP檢查器進行測試（開發模式）
npm run inspect:dev

本地MCP客戶端配置（開發模式）

{
  "mcpServers": {
    "mcp-docs-server": {
      "command": "npx",
      "args": ["tsx", "/path/to/mcp-docs-server/src/index.ts"]
    }
  }
}

📚 詳細文檔

架構

src/
├── index.ts          # MCP服務器入口點
├── config.ts         # 配置文件
├── tools/
│   └── docs.ts       # search_mcp_docs, fetch_mcp_doc
└── utils/
    ├── cache.ts      # 文檔緩存
    ├── doc-fetcher.ts # HTTP獲取和HTML解析
    ├── indexer.ts    # BM25搜索索引
    ├── logger.ts     # 日誌工具
    ├── stopwords.ts  # 停用詞列表
    ├── text-processor.ts # 文本工具
    └── url-validator.ts  # URL驗證

搜索算法

搜索使用了經過增強的BM25（最佳匹配25）算法：

• Porter詞幹提取：匹配單詞變體（例如，"running" → "run"）。
• 二元組：捕捉短語匹配（例如，"tool input"）。
• 加權評分：
  • 標題匹配：提升3 - 8倍。
  • 標題匹配：權重為4倍。
  • 代碼塊：權重為2倍。
  • 鏈接文本：權重為2倍。
• 保留領域術語：像 "mcp"、"json"、"stdio" 這樣的技術術語不進行詞幹提取。

📄 許可證

本項目採用MIT許可證。