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许可证。