关键词

知识库检索信息检索RagieLLM工具企业知识库

项目简介

Ragie MCP服务器是一个实现了Model Context Protocol (MCP) 的后端应用，旨在让大型语言模型 (LLM) 能够访问 Ragie 知识库进行信息检索。该服务器通过标准化的 MCP 协议与 LLM 客户端通信，提供了一个名为 'retrieve' 的工具，使 LLM 能够利用 Ragie 的知识库能力。

主要功能点

  • 知识库检索: 提供 'retrieve' 工具，允许 LLM 客户端查询 Ragie 知识库，获取相关信息。
  • 工具化能力: 通过 MCP 协议向 LLM 客户端暴露 'retrieve' 工具，方便 LLM 应用集成知识库检索功能。
  • 标准化协议: 基于 Model Context Protocol 构建，保证了与 MCP 客户端的兼容性和互操作性。
  • 易于部署: 通过简单的 npx 命令即可启动，并可通过环境变量进行配置。

安装步骤

  1. 安装 Node.js: 确保你的系统已安装 Node.js (>= 18)。
  2. 设置环境变量: 你需要设置 'RAGIE_API_KEY' 环境变量，这是访问 Ragie API 的认证密钥。你可以选择性设置 'RAGIE_PARTITION' 环境变量来指定 Ragie 分区。
    • 在 Linux/macOS 中，可以使用 'export RAGIE_API_KEY=你的API密钥' 和 'export RAGIE_PARTITION=你的分区ID (可选)' 命令。
    • 在 Windows 中，可以使用 'set RAGIE_API_KEY=你的API密钥' 和 'set RAGIE_PARTITION=你的分区ID (可选)' 命令。
  3. 安装并运行服务器: 在终端中运行以下命令即可安装并启动 Ragie MCP 服务器： 
    RAGIE_API_KEY=your_api_key RAGIE_PARTITION=optional_partition_id npx @ragieai/mcp-server
    请将 'your_api_key' 替换为你的 Ragie API 密钥，'optional_partition_id' 替换为你的 Ragie 分区 ID（如果需要）。

服务器配置

对于 MCP 客户端（例如 Claude Desktop），你需要配置 MCP 服务器的连接信息。以下是一个 'claude_desktop_config.json' 文件的示例配置，用于连接 Ragie MCP 服务器：

{
  "mcpServers": {
    "ragie": {  // 服务器名称，客户端用于识别和调用
      "command": "npx", // 启动服务器的命令
      "args": [      // 命令参数
        "-y",
        "@ragieai/mcp-server"
      ],
      "env": {    // 环境变量
        "RAGIE_API_KEY": "your_api_key", // Ragie API 密钥，**请替换为你的实际密钥**
        "RAGIE_PARTITION": "optional_partition_id" // 可选的 Ragie 分区 ID，**可选配置**
      }
    }
  }
}

配置说明:

  • '"ragie"': MCP 服务器的名称，可以自定义，客户端通过此名称引用该服务器。
  • '"command": "npx"': 启动服务器的命令，这里使用 'npx' 直接运行 npm 包。
  • '"args": ["-y", "@ragieai/mcp-server"]': 'npx' 命令的参数，'-y' 表示自动确认安装包，'@ragieai/mcp-server' 是要执行的 npm 包名称。
  • '"env": { ... }': 设置服务器运行时需要的环境变量。
    • '"RAGIE_API_KEY"': 必须配置，你的 Ragie API 密钥，用于服务器认证 Ragie 服务。
    • '"RAGIE_PARTITION"': 可选配置，指定要查询的 Ragie 分区 ID。

Claude Desktop 配置步骤:

  1. 创建配置文件: 根据你的操作系统，创建 'claude_desktop_config.json' 文件：
    • macOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
    • Windows: '%APPDATA%/Claude/claude_desktop_config.json'
  2. 复制配置信息: 将上面的 JSON 配置信息复制到 'claude_desktop_config.json' 文件中，并替换 '"your_api_key"' 为你的实际 Ragie API 密钥。如果需要，配置 '"RAGIE_PARTITION"'。
  3. 重启 Claude Desktop: 重启 Claude Desktop 应用，配置即可生效。

基本使用方法

配置完成后，在支持 MCP 协议的 LLM 客户端中（例如 Claude Desktop），你就可以使用 Ragie MCP 服务器提供的 'retrieve' 工具了。

当 LLM 需要访问知识库信息时，它会通过 MCP 协议调用 'retrieve' 工具，并提供 'query' 参数来指定搜索关键词。服务器将返回包含从知识库检索到的相关文本内容，LLM 可以利用这些内容来生成更准确、更全面的回复。

例如，在 Claude Desktop 中，你可以指示 Claude 使用 'ragie:retrieve' 工具来检索信息，例如：

请使用 ragie:retrieve 工具搜索 "公司最新的财务政策"。

或者在 Prompt 中直接指示模型调用该工具。

{
  "tool_code": "<ragie:retrieve>",
  "parameters": {
    "query": "公司最新的财务政策"
  }
}

开发说明

如果你需要进行二次开发，仓库提供了详细的开发指南，项目使用 TypeScript 构建，依赖 '@modelcontextprotocol/sdk'、'ragie' 和 'zod' 等库。你可以参考仓库的 'README.md' 文件中的 "Development" 部分了解更多信息。

信息

分类

商业系统

访问项目