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 文件。