open-docs-mcp MCP Server

open-docs-mcp MCP Server

site icon
2025.04.09 4
JavaScript文档管理全文搜索开发工具集成内容生成开发效率
open-docs-mcp 是一个开源的 MCP 实现,专注于文档管理功能。它能够从各种来源爬取和索引文档,支持多种文档格式,并提供全文搜索能力。该项目还旨在复制 Cursor 的 @Docs 功能,提供文档索引、文档访问和自定义文档管理等功能。
View on GitHub

Overview

基本能力

产品定位

open-docs-mcp 是一个开源的 MCP 实现,专注于文档管理功能。

核心功能

  1. 文档管理
  2. 从各种来源爬取和索引文档
  3. 支持多种文档格式
  4. 全文搜索能力

  5. MCP Server API

  6. 基于资源的文档访问
  7. 基于工具的文档管理

  8. Cursor @Docs 兼容性

  9. 文档索引
  10. 文档访问
  11. 自定义文档管理

适用场景

  • 需要管理和搜索大量文档的项目
  • 需要集成文档搜索功能的开发工具
  • 需要自动化文档管理的场景

工具列表

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

常见问题解答

  • 如何配置文档目录?使用 --docsDir 参数指定文档目录路径。
  • 如何临时禁用服务器?在配置文件中设置 "disabled": true
  • 哪些工具可以无需确认使用?在配置文件中设置 alwaysAllow 数组。

使用教程

使用依赖

  • Node.js >= 16.0.0
  • TypeScript 4.9.5

安装教程

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"
      ]
    }
  }
}

调试方式

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

许可证

该项目遵循 MIT 开源许可条款。