基本能力
产品定位
open-docs-mcp 是一个开源的 MCP 实现,专注于文档管理功能。
核心功能
- 文档管理
- 从各种来源爬取和索引文档
- 支持多种文档格式
-
全文搜索能力
-
MCP Server API
- 基于资源的文档访问
-
基于工具的文档管理
-
Cursor @Docs 兼容性
- 文档索引
- 文档访问
- 自定义文档管理
适用场景
- 需要管理和搜索大量文档的项目
- 需要集成文档搜索功能的开发工具
- 需要自动化文档管理的场景
工具列表
- enable_doc - 启用特定文档的爬取
- disable_doc - 禁用特定文档的爬取
- crawl_docs - 开始爬取已启用的文档
- build_index - 为文档构建搜索索引
- search_docs - 搜索文档
- list_enabled_docs - 列出已启用的文档
- list_all_docs - 列出所有可用的文档
常见问题解答
- 如何配置文档目录?使用
--docsDir
参数指定文档目录路径。 - 如何临时禁用服务器?在配置文件中设置
"disabled": true
。 - 哪些工具可以无需确认使用?在配置文件中设置
alwaysAllow
数组。
使用教程
使用依赖
- Node.js >= 16.0.0
- TypeScript 4.9.5
安装教程
bash
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
json
{
"mcpServers": {
"open-docs-mcp": {
"command": "npx",
"args": [
"-y",
"open-docs-mcp",
"--docsDir",
"/path/to/docs"
]
}
}
}
调试方式
bash
npm run watch # 自动重建更改
npm run inspector # 使用 MCP Inspector 调试