使用说明
Docmole
Dig through any documentation with AI
Docmole是一个MCP服务器，允许您查询 任何文档网站 来自Claude、Cursor或任何兼容MCP的客户端等AI助手。鼹鼠会翻查文件，所以你不必这么做。
特性
- 🔍 通用文档支持 --适用于任何文档网站
- 🏠 自托管RAG --LanceDB向量+OpenAI嵌入，无需Python
- ⚡ 零设置模式 --即时访问由Mintlify提供支持的网站
- 🧠 多回合对话 --跨问题记住上下文
- 🔗 WebFetch兼容 --链接转换为绝对URL
- 🔌 MCP本地 --适用于Claude、Cursor和任何MCP客户端
即将推出
- 🦙 Olama支持 -完全本地模式，不需要API密钥
- 📄 通用HTML提取 --支持非Mintlify文档网站
- 🔄 增量更新 --仅重新索引已更改的页面
安装
要使用Docmole，请直接使用bunx运行它（无需安装）：
bunx docmole --help
或全局安装：
bun install -g docmole
适用于macOS、Linux和Windows。需要 包子 运行时。
入门
本地RAG模式（任何文档站点）
索引和查询任何文档网站。需要 OPENAI_API_KEY.
# One-time setup — discovers pages and builds vector index
bunx docmole setup --url https://docs.example.com --id my-docs
# Start the MCP server
bunx docmole serve --project my-docs
添加到您的MCP客户端：
{
"mcpServers": {
"my-docs": {
"command": "bunx",
"args": ["docmole", "serve", "--project", "my-docs"]
}
}
}
Mintlify模式（零点设置）
对于具有以下特性的网站 Mintlify人工智能助理 -不需要API密钥：
bunx docmole -p agno-v2
{
"mcpServers": {
"agno-docs": {
"command": "bunx",
"args": ["docmole", "-p", "agno-v2"]
}
}
}
命令行界面
Docmole有一个内置的CLI用于所有操作：
# Mintlify mode (proxy to Mintlify API)
docmole -p <project-id>
# Local RAG mode
docmole setup --url <docs-url> --id <project-id>
docmole serve --project <project-id>
docmole list
docmole stop --project <project-id>
跑 docmole --help 对于所有选项。
运作原理
┌─────────────┐ ┌─────────────┐ ┌──────────────────────┐
│ MCP Client │────▶│ Docmole │────▶│ Embedded: LanceDB │
│ (Claude, │◀────│ MCP Server │◀────│ Mintlify: API proxy │
│ Cursor...) │ └─────────────┘ └──────────────────────┘
└─────────────┘
本地RAG模式：抓取文档，使用OpenAI生成嵌入，存储在LanceDB中。混合搜索结合了语义和关键字匹配。
Mintlify模式：代理对Mintlify的AI助手API的请求。零设置，即时结果。
已知的Mintlify项目ID
| 文档 | 项目ID |
|---|---|
| 硝酸银 | agno-v2 |
| 重发 | resend |
| 明特利 | mintlify |
| 维塞尔 | vercel |
| 上架 | upstash |
| 平原 | plain |
查找更多信息：打开DevTools→ 网络选项卡→ 使用AI助手→ 寻找
leaves.mintlify.com/api/assistant/{project-id}/message
配置
| 环境变量 | 默认值 | 描述 |
|---|---|---|
OPENAI_API_KEY |
-- | 本地RAG模式需要 |
DOCMOLE_DATA_DIR |
~/.docmole |
项目数据目录 |
项目结构
~/.docmole/
├── projects/
│ └── <project-id>/
│ ├── config.yaml # Project configuration
│ └── lancedb/ # Vector database
└── global.yaml # Global settings
文档
看 AGENT.md 详细文件包括：
- 建筑细部
- 后端实现
- 企业部署指南
贡献
PR欢迎！请参阅 贡献指南 了解详情。
致谢
许可证
Docmole代码库位于 MIT许可证.
