QMD — Quality Markdown Formatter

✨ QMD — Quality Markdown Formatter

QMD — Quality Markdown Formatter

收藏
1.9k
安装
753
版本
1.0.0
CLS 安全性认证2026-08-03
点击查看完整报告 >

使用说明

安全解读

核心用法

qmd 是一个本地文件搜索与索引 CLI 工具,本 Skill 为其纯文档型使用指南。核心功能分为索引管理智能检索两大模块:

索引构建:通过 qmd collection add /path --name docs --mask "**/*.md" 添加待索引文件夹,支持 glob 模式匹配;qmd update 增量更新索引,数据默认存储于 ~/.cache/qmd

多模式检索:提供三种查询方式——传统 BM25 关键词搜索(qmd search)、纯向量语义搜索(qmd vsearch)、以及 BM25+向量融合的重排序混合搜索(qmd query)。支持精确获取文档片段:qmd get docs/path.md:10 -l 40 可定位到具体文件行号。

MCP 集成:通过 qmd mcp 启动 MCP 模式,使大语言模型客户端能够直接访问本地索引库,实现 RAG(检索增强生成)场景的知识库对接。

底层依赖 Ollama 提供嵌入与重排序能力(默认 http://localhost:11434),无需云端 API 即可离线运行。

显著优点

1. 混合搜索架构:BM25 保证关键词精确匹配,向量搜索捕获语义相似性,rerank 层优化结果排序,三者结合显著提升召回质量。

2. 完全本地离线:索引、嵌入、推理全流程本地化,敏感数据不出境,满足隐私合规要求。

3. 轻量零配置:单二进制文件,默认缓存路径即开即用,Ollama 生态无缝集成。

4. MCP 协议原生支持:可直接接入 Claude Desktop 等 MCP 客户端,成为个人知识库的检索后端。

潜在缺点与局限性

  • 依赖外部 Ollama:向量功能强绑定本地 Ollama 服务,若未运行则功能降级为纯 BM25。
  • 索引维护成本:大规模文档集首次索引耗时较长,增量更新策略需用户自行管理。
  • 无权限隔离:MCP 模式缺乏内置访问控制,多用户场景存在数据越界风险。
  • Skill 本身无执行能力:本 Skill 仅为文档指导,实际功能需用户自行安装配置 qmd 二进制文件。

适合的目标群体

  • 需要构建个人/团队本地知识库的知识工作者、研究员、开发者
  • 数据隐私敏感、要求完全离线运行的企业内网用户
  • 希望为 MCP 客户端(如 Claude)接入私有化文档检索能力的 AI 应用构建者
  • 习惯命令行工具、熟悉 Ollama 生态的技术用户

使用风险

1. 敏感文件泄露风险:索引范围配置不当可能将密钥、配置文件纳入缓存,建议严格限制 --mask 参数。

2. MCP 模式暴露面:MCP 服务监听可能暴露索引内容,仅限可信本地环境启用。

3. 供应链安全风险:qmd 工具由个人开发者维护,建议锁定版本并关注上游安全公告。

4. 缓存完整性风险~/.cache/qmd 目录损坏可能导致索引失效,重要场景建议定期备份。

QMD — Quality Markdown Formatter 内容

手动下载zip · 2.0 kB
skill-card.mdtext/markdown
请选择文件