本地文档检索工具

2分钟前更新 1 00
本地文档检索工具本地文档检索工具
本地文档检索工具

技能简介

qmd 是一款本地文件搜索与索引命令行工具,支持 BM25 全文检索、向量语义搜索及混合查询模式,可通过 MCP 协议与外部系统对接。

业务背景

本地文档检索工具让企业知识库摆脱云端依赖,在完全离线的环境中实现精准查找。BM25与向量混合搜索兼顾关键词匹配与语义理解,适合技术手册、合同文本、研发笔记等结构化与非结构化资料的统一管理。

落地案例:某律所将历年判例文书存入本地服务器,律师输入"房屋租赁违约金计算标准",系统先以BM25定位含关键词的条款段落,再通过向量搜索扩展至"滞纳金""赔偿责任"等相关表述,最终按混合得分排序呈现最相关的三段原文及出处页码,大幅缩短案头研究时间。

能做什么

  • 为本地目录建立可更新的文档索引
  • 执行 BM25 关键词搜索或向量语义搜索
  • 组合 BM25 与向量结果进行混合排序
  • 通过 MCP 模式提供标准化接口服务

使用说明

安装

npm install -g https://github.com/tobi/qmd

基础用法

  1. 添加索引集合:qmd collection add /path --name docs --mask "**/*.md"
  2. 更新索引数据:qmd update
  3. 查看索引状态:qmd status
  4. BM25 搜索:qmd search "query"
  5. 向量搜索:qmd vsearch "query"
  6. 混合查询:qmd query "query"
  7. 获取指定文档内容:qmd get docs/path.md:10 -l 40

环境配置

  • 嵌入模型与重排序依赖 Ollama,默认地址 http://localhost:11434,可通过 OLLAMA_URL 修改
  • 索引数据默认存储于 ~/.cache/qmd

输入与输出

见下方输入与输出表格。

项目内容
输入本地文件路径、搜索查询语句、集合名称与文件掩码、Ollama 服务端点配置
输出BM25 搜索结果列表、向量相似度排名、混合排序后的文档片段、指定文档的文本内容
适用人群需要离线搜索本地知识库的用户、构建私有文档问答系统的开发者、希望通过 MCP 集成搜索能力的 AI 应用
不包含云端托管服务、多用户权限管理、可视化 Web 界面

 

风险提示

  • 需本地运行 Ollama 服务以支持向量功能
  • 索引占用磁盘空间随文档量增长
  • MCP 模式下的网络暴露需评估访问控制

来源信息

原始链接:https://github.com/openclaw/skills/tree/main/skills/steipete/qmd/SKILL.md
来源类型:GitHub 仓库

数据统计

相关导航

暂无评论

none
暂无评论...