open-docs-mcp MCP 服务器

一个提供文档管理功能的开源 MCP 实现。 中文文档

功能

文档管理

• 从各种来源抓取和索引文档
• 支持多种文档格式
• 全文搜索功能

MCP 服务器 API

• 基于资源的文档访问
• 基于工具的文档管理

可用工具

1. enable_doc - 启用特定文档的抓取
2. disable_doc - 禁用特定文档的抓取
3. crawl_docs - 开始抓取已启用的文档
4. build_index - 为文档构建搜索索引
5. search_docs - 搜索文档
6. list_enabled_docs - 列出已启用的文档
7. list_all_docs - 列出所有可用文档

Cursor @Docs 兼容性

本项目旨在通过提供以下功能来复刻 Cursor 的 @Docs 功能：

1. 文档索引:

   • 从各种来源抓取和索引文档
   • 支持多种文档格式（HTML、Markdown 等）
   • 自动重新索引以保持文档最新

2. 文档访问:

   • 搜索所有索引的文档
   • 与 MCP 协议集成以提供 AI 上下文

3. 自定义文档管理:

   • 通过 enable_doc 工具添加新的文档来源
   • 通过 list_enabled_docs 工具管理已启用的文档
   • 使用 crawl_docs 工具强制重新抓取

架构

┌───────────────────────────────────────────────────────┐
│                    open-docs-mcp 服务器                    │
├───────────────────┬───────────────────┬───────────────┤
│   爬虫模块  │  搜索引擎    │  MCP 服务器   │
├───────────────────┼───────────────────┼───────────────┤
│ - Web 爬取    │ - 全文索引 │ - 资源   │
│ - 文档转换  │ - 相关性评分 │ - 工具       │
│ - 存储         │ - 查询解析   │ - 提示     │
└───────────────────┴───────────────────┴───────────────┘

用法

npx -y open-docs-mcp --docsDir ./docs

配置

要与 Claude Desktop 一起使用，请添加服务器配置：

在 MacOS 上：~/Library/Application Support/Claude/claude_desktop_config.json 在 Windows 上：%APPDATA%/Claude/claude_desktop_config.json

{
  "mcpServers": {
    "open-docs-mcp": {
      "command": "npx",
      "args": [
        "-y",
        "open-docs-mcp",
        "--docsDir",
        "/path/to/docs"
      ]
    }
  }
}

配置选项：

• command: Node.js 可执行文件
• args: 传递给脚本的参数数组
  • --docsDir: 必需，指定文档目录路径
• disabled: 设置为 true 以暂时禁用服务器
• alwaysAllow: 可以无需确认即可使用的工具名称数组

开发

npm run watch  # 在更改时自动重新构建
npm run inspector  # 使用 MCP Inspector 调试

文档

完整文档位于 docs 目录中。

贡献

欢迎提交 Pull Request。对于重大更改，请先打开一个 issue 讨论您想要更改的内容。

许可证

MIT