open-docs-mcp

🚀 open-docs-mcp 文档服务器

open-docs-mcp 是一个开源的 MCP 实现项目，它具备强大的文档管理功能，能从多来源抓取和索引文档，支持多种格式并提供全文搜索，还模拟了 Cursor 的 @Docs 功能，为用户提供便捷的文档使用体验。

[中文文档][url-doczh]

✨ 主要特性

文档管理

• 可从多个来源抓取并索引文档，轻松整合多方资料。
• 支持多种文档格式，满足多样化的文档需求。
• 提供全文搜索功能，让您快速定位所需内容。

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 上下文，为 AI 应用提供支持。
3. 自定义文档管理：
   • 通过 enable_doc 工具添加新的文档来源，丰富文档资源。
   • 使用 list_enabled_docs 工具管理已启用的文档，方便快捷。
   • 使用 crawl_docs 工具强制重新抓取，确保文档的准确性。

架构

┌───────────────────────────────────────────────────────┐
│                    open-docs-mcp Server                    │
├───────────────────┬───────────────────┬───────────────┤
│   Crawler Module  │  Search Engine    │  MCP Server   │
├───────────────────┼───────────────────┼───────────────┤
│ - 网页抓取         │ - 全文索引       │ - 文档管理    │
│ - 文档存储        │                  │              │
└───────────────────┴───────────────────┴───────────────┘

📦 安装指南

安装步骤：

1. 克隆仓库：git clone https://github.com/your-repository.git
2. 进入目录：cd open-docs-mcp
3. 安装依赖：npm install

配置文件

您可以创建一个 config.json 文件来配置服务器：

{
  "port": 3000,
  "documentRoot": "./documents"
}

🚀 快速开始

要运行 open-docs-mcp 服务器，可以使用以下命令：

npm start

开发

要开始开发，可以运行以下命令：

• 监控文件变化：npm run watch
• 启动调试模式：npm run debug

🤝 贡献指南

我们欢迎社区贡献！请参考项目仓库中的 CONTRIBUTING.md 了解如何参与。

📄 许可证

本项目遵循 MIT 许可证，具体条款见 LICENSE 文件。