使用说明

项目简介

RAG Kit MCP Server 是一个实现了 Model Context Protocol (MCP) 的服务器，旨在为大型语言模型（LLM）应用提供强大的检索增强生成（RAG）能力。它允许 LLM 通过标准化的 MCP 接口与向量数据库（Qdrant）进行交互，从而实现高效的知识检索和上下文管理。该服务器提供了一系列工具，用于向量数据的索引、搜索和管理，使得 LLM 能够利用外部知识库生成更准确、更丰富的回答。

主要功能点

向量数据库集成: 深度集成 Qdrant 向量数据库，实现高效的向量数据存储和检索。
RAG 工具集: 提供了一套完整的 RAG 工具，包括：
- 数据索引: 支持索引本地文件和文本内容到向量数据库中。
- 集合管理: 支持创建、删除和列出向量集合（collection）。
- 向量搜索: 根据用户查询在向量集合中进行相似性搜索。
- 索引管理: 支持根据文件路径删除向量索引。
可配置的工具: 允许用户通过环境变量灵活启用或禁用特定的工具组，例如 RAG 工具组。
标准 MCP 协议: 遵循 Model Context Protocol，保证与 MCP 客户端的兼容性和互操作性。
易于部署: 使用 Go 语言开发，编译为单个可执行文件，易于安装和部署。

安装步骤

安装 Go: 确保已安装 Go 1.23.2 或更高版本。

安装 RAG Kit: 使用 Go 命令安装 RAG Kit 服务器：

go install github.com/nguyenvanduocit/rag-kit@latest

配置环境变量: 创建 '.env' 文件，并根据需要配置以下环境变量：

# Qdrant 配置 (必须)
QDRANT_HOST= # Qdrant 服务器主机地址 (必须)
QDRANT_PORT= # Qdrant 服务器端口 (必须)
QDRANT_API_KEY= # Qdrant API 密钥 (必须)

# OpenAI 配置 (必须)
OPENAI_API_KEY= # OpenAI API 密钥 (必须，用于生成文本向量)

# 可选配置
ENABLE_TOOLS= # 可选：逗号分隔的工具组列表，用于启用特定工具组 (留空则启用所有工具)。例如： rag
PROXY_URL= # 可选：HTTP/HTTPS 代理 URL，如果需要通过代理访问网络

请务必根据您的 Qdrant 和 OpenAI 实际配置，填写 '.env' 文件。

服务器配置

MCP 客户端需要配置 MCP 服务器的启动命令和参数才能连接到 RAG Kit MCP Server。以下是 RAG Kit 的服务器配置信息，请复制到您的 MCP 客户端配置中 (例如 Claude 的配置)：

{
  "mcpServers": {
    "rag_kit": {
      "command": "rag-kit",
      "args": ["-env", "/path/to/.env"]
      // 请将 "/path/to/.env" 替换为您实际的 .env 文件路径。
      // 建议使用绝对路径，确保服务器能够正确加载环境变量。
      // command 字段指定了启动 RAG Kit 服务器的可执行文件名称 (rag-kit)。
      // args 字段传递了 "-env" 参数和 .env 文件路径，用于指定环境变量配置文件。
    }
  }
}

注意:

请将上述 JSON 配置添加到您的 MCP 客户端的服务器配置中。
将 '"rag_kit"' 作为服务器名称，您可以在客户端中通过这个名称来调用 RAG Kit 提供的工具。
确保 'command' 字段设置为 'rag-kit'，这是 RAG Kit 服务器的可执行文件名。
'args' 字段中的 '"/path/to/.env"' 必须替换为您实际的 '.env' 文件路径，建议使用绝对路径以避免路径解析错误。
MCP 客户端将使用 Stdio 协议与 RAG Kit 服务器进行通信。

基本使用方法

启动 RAG Kit MCP Server: MCP 客户端配置完成后，当客户端需要与 RAG Kit 服务器交互时，会自动启动 RAG Kit 服务器进程。您无需手动启动服务器。
在 MCP 客户端中使用 RAG 工具: 您可以使用 MCP 客户端提供的界面或 API，通过 "rag_kit" 服务器名称调用 RAG Kit 提供的工具。例如，您可以调用 'RAG_memory_index_file' 工具来索引本地文件，或调用 'RAG_memory_search' 工具来搜索向量数据库。
工具参数配置: 调用工具时，需要根据工具的参数定义 (例如 'collection', 'filePath', 'query' 等) 在 MCP 客户端中配置相应的参数值。

具体工具的使用方法和参数说明，请参考 RAG Kit 的代码和文档，或 MCP 客户端的工具调用指南。

关键词