open-docs-mcp MCP 服务器
提供文档管理功能的开源MCP实现。中文文档
特征
文档管理
- 从各种来源抓取并索引文档
- 支持多种文档格式
- 全文搜索功能
MCP 服务器 API
可用工具
- enable_doc - 启用特定文档的抓取
- disable_doc - 禁用对特定文档的抓取
- crawl_docs - 开始抓取已启用的文档
- build_index - 为文档构建搜索索引
- search_docs - 搜索文档
- list_enabled_docs - 列出已启用的文档
- list_all_docs - 列出所有可用的文档
Cursor @Docs 兼容性
该项目旨在通过提供以下内容来复制 Cursor 的 @Docs 功能:
- 文档索引:
- 从各种来源抓取并索引文档
- 支持多种文档格式(HTML、Markdown 等)
- 自动重新索引以使文档保持最新
- 文档访问:
- 在所有索引文档中搜索
- 与 MCP 协议集成以实现 AI 上下文
- 自定义文档管理:
- 通过
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
:传递给脚本的参数数组disabled
:设置为 true 以暂时禁用服务器alwaysAllow
:无需确认即可使用的工具名称数组
发展
npm run watch # Auto-rebuild on changes
npm run inspector # Debug with MCP Inspector
贡献
欢迎提交 Pull 请求。对于重大变更,请先提交一个 issue 来讨论您想要修改的内容。
执照
麻省理工学院