用途
knowledge-rag 是面向 MCP 客户端的本地 RAG(检索增强生成)服务器,适用于 Claude Code、Cursor、Windsurf、VS Code、Cline、Gemini CLI、Zed 等。它让 AI 智能体在回答前优先检索本地知识库,将“能访问 RAG 的 AI”变为“真正先用 RAG 的 AI”。项目强调 100% 本地、零云依赖,嵌入生成、索引和检索均在本地完成。
主要能力
- 混合检索:语义向量 + BM25 关键词检索,可选 FTS5 词法快速路径。
- 交叉编码器重排序:使用 Xenova/ms-marco-MiniLM-L-6-v2 对候选池评分。
- Markdown 感知分块与查询扩展;支持 35 种文件格式解析(资料中另有“20 format parsers”表述,具体数值以仓库为准)。
- 13 个 MCP 工具,覆盖检索与知识库 CRUD 操作。
- 查询缓存:LRU + 5 分钟 TTL,写操作时失效。
- 暂存重建:在不影响当前集合的情况下构建并校验新集合,发布失败可回滚。
- 异步后台重建,通过 get_reindex_status() 轮询状态。
- 10 个面向 AI 智能体的行为技能(skills/ 目录),按类型组织,帮助智能体主动使用 RAG。
- 企业级功能:Bearer 令牌认证、Prometheus /metrics、限流、健康探针、结构化 JSON 日志、路径穿越与符号链接逃逸防护。
使用方式
共有三条集成路径,服务端在每条通道中相同。
路径 1:MCP 客户端(Claude Code、Cursor、Windsurf、Cline、VS Code、Gemini CLI、Zed) 将 PDF、Markdown、代码文件放入 documents/ 目录,重启 MCP 客户端即可提问。首次查询会加载约 200MB 的 ONNX 嵌入模型(一次性下载),后续查询走缓存,可达到亚秒级延迟。
安装命令: pip install knowledge-rag
安装技能有两种最短路径,安装后重启 Claude Code 即可:
- 选项 1(资料未给出具体命令)
- 选项 2 支持 --project、--only rag-check-first,rag-cite-sources、--dry-run、--help 参数(资料未给出完整命令字符串)。
路径 2:HTTP / SSE 服务器(多用户、气隙、负载均衡)
- 健康探针:curl http://your-host:8179/health → 200 + JSON 负载
- Prometheus 抓取:http://your-host:9179/metrics
- MCP 调度:通过 Authorization: Bearer your-secret-token 认证
多客户端共享(Streamable HTTP):当多个客户端共享同一索引和进程时,以 Streamable HTTP 方式运行一次,各 HTTP 客户端指向同一端点。本地 MCP 客户端(Cursor、LM Studio 等)可将远程服务器 URL 指向 http://127.0.0.1:8179/mcp。Claude 自定义连接器(远程 MCP)请求来自 Anthropic 云基础设施,无法访问本地 127.0.0.1,需通过 HTTPS 公网端点暴露,例如 Cloudflare Tunnel、ngrok 或反向代理,指向 https://your-public-domain/mcp;代理需发送 HTTP 应用可接受的 Host,默认回环配置为 127.0.0.1:8179,否则可能出现 421 Invalid Host header。在 Claude(Pro/Max:Customize > Connectors > + Add > Add custom connector;Team/Enterprise:Organization settings > Connectors)中输入公网端点,在 Request headers 中设置 Authorization: Bearer <your-token>,与 config.yaml 中 server.auth.bearer_token 一致。启用 HTTP 传输时,knowledge-rag 自动开启单实例锁(KNOWLEDGE_RAG_SINGLE_INSTANCE=1),防止多个服务器绑定同一数据目录或端口。默认主机为 127.0.0.1;若绑定 0.0.0.0 或跨网络部署,应在 config.yaml 配置 server.auth.bearer_token 并通过反向代理(Caddy、Nginx)终止 TLS,否则服务器会警告 HTTP 端点未认证。
路径 3:Docker(模型已预下载,气隙就绪)。
完整安装说明(5 种方法、8 种 MCP 客户端配置、GPU 设置):docs/INSTALLATION.md
适用场景
- 安全团队(红队/蓝队/CTF):预设 cybersecurity.yaml,8 个类别、200+ 路由关键词、69 个查询扩展,可索引 MITRE ATT&CK、威胁报告、漏洞利用文章和事件报告,通过 search_knowledge("privilege escalation windows") 检索。
- 开发团队:预设 developer.yaml,9 个类别、150+ 路由关键词、50+ 扩展,索引架构文档、ADR、运行手册、代码、API 规范,替代在 Confluence 中翻找。
- 研究实验室:预设 research.yaml,9 个类别、100+ 路由关键词、40+ 扩展,索引 arXiv 论文、实验笔记、数据集文档。
- 企业知识库(气隙、可审计):预设 general.yaml,通过单台 VM 上的 SSE 部署,40+ 用户 Bearer 认证、限流、Prometheus 监控、/health 探针接入负载均衡、JSON 日志发送到 Datadog。
限制与说明
- 100% 本地指嵌入生成、索引和检索本地运行;模型下载和 add_from_url 需要网络访问,配置的 MCP 客户端会收到检索内容。
- 项目不认证监管合规;客户需自行选择语料库、客户端权限和网络暴露范围。
- 默认主机为 127.0.0.1;跨网络部署需自行配置认证与 TLS。
- 检索内容应被视为不可信数据,客户端需自行处理。
- CI 覆盖不保证零缺陷;审计报告记录的是可复现的本地工作负载及其限制,与旧实现的对比并非与其他 RAG 框架的速度比较。
- GPU 可选,CPU 配合 FastEmbed ONNX 可正常工作;NVIDIA CUDA 嵌入与实验性 Windows AMD DirectML 为可选,CPU 回退。
- 具体价格、收费模式资料未提供。