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服务器   │
├───────────────────┼───────────────────┼───────────────┤
│ - 网页爬取        │ - 全文索引       │ - 资源       │
│ - 文档转换        │ - 相关性评分     │ - 工具       │
│ - 存储            │ - 查询解析       │ - 提示       │
└───────────────────┴───────────────────┴───────────────┘

使用方法

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

通过Smithery安装

要通过Smithery自动安装文档管理系统到Claude Desktop：

npx -y @smithery/cli install @askme765cs/open-docs-mcp --client claude

配置

要在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调试

贡献

欢迎提交拉取请求。对于重大更改，请先打开问题讨论您想要更改的内容。

许可证

MIT