qmd 是一个本地搜索与索引命令行工具,主要用途是对本地文件建立索引并进行检索。它同时支持 BM25 关键词检索、向量检索以及两者结合的重排序检索,并提供 MCP 模式,便于被其他支持 MCP 的工具调用。
主要能力
- 索引管理:可添加集合、更新索引、查看状态。
- 多种检索方式:BM25 关键词检索、向量检索、混合检索(query)。
- 文档读取:可按文件路径与行号范围获取文档内容。
- MCP 模式:通过 qmd mcp 启动。
使用方式
添加集合:qmd collection add /path --name docs --mask "**/*.md"
更新索引:qmd update
查看状态:qmd status
BM25 检索:qmd search "query"
向量检索:qmd vsearch "query"
混合检索:qmd query "query"
获取文档:qmd get docs/path.md:10 -l 40
启动 MCP 模式:qmd mcp
适用场景
适合需要在本地对文件(例如 Markdown 文档)建立索引并进行关键词、向量或混合检索的场景,也适合通过 MCP 模式集成到其他工具中使用。
限制与依赖
嵌入与重排序使用 Ollama,地址由 OLLAMA_URL 指定,默认 http://localhost:11434。索引默认位于 ~/.cache/qmd。关于支持的文件类型范围、性能表现、平台兼容性及收费情况,资料暂未提供。