Open Docs Mcp

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 Server                    │
├───────────────────┬───────────────────┬───────────────┤
│   Crawler Module  │  Search Engine    │  MCP Server   │
├───────────────────┼───────────────────┼───────────────┤
│ - Web crawling    │ - Full-text index │ - Resources   │
│ - Doc conversion  │ - Relevance score │ - Tools       │
│ - Storage         │ - Query parsing   │ - Prompts     │
└───────────────────┴───────────────────┴───────────────┘

使用方法

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  # Auto-rebuild on changes
npm run inspector  # Debug with MCP Inspector

参与贡献

欢迎提交拉取请求。对于重大更改，请先创建 issue，讨论您希望进行的更改。

许可证

MIT