Ragie Model Context Protocol Server

重要！

此项目已不再需要。Ragie 现在原生支持 MCP，可作为可流式传输的 HTTP 服务运行。请参阅此处的文档：[https://docs.ragie.ai/docs/mcp-overview]

如果你希望公司内的用户能够在 Claude 或 ChatGPT 等应用中访问你的知识库，可能需要使用 MCP Bridge

Ragie Model Context Protocol 服务

一个 Model Context Protocol（MCP）服务，可访问 Ragie 的知识库检索功能。

描述

此服务实现了 Model Context Protocol，使 AI 模型能够从 Ragie 知识库中检索信息。它提供一个名为“retrieve”的工具，用于查询知识库并查找相关信息。

前置条件

• Node.js >= 18
• Ragie API 密钥

安装

此服务需要以下环境变量：

• RAGIE_API_KEY（必填）：用于验证 Ragie API 身份的密钥

服务将启动并通过 stdio 监听 MCP 协议消息。

使用 npx 安装并运行服务：

RAGIE_API_KEY=your_api_key npx @ragieai/mcp-server

命令行选项

此服务支持以下命令行选项：

• --description, -d <text>：使用自定义文本覆盖默认工具描述
• --partition, -p <id>：指定要查询的 Ragie 分区 ID

示例：

# With custom description
RAGIE_API_KEY=your_api_key npx @ragieai/mcp-server --description "Search the company knowledge base for information"

# With partition specified
RAGIE_API_KEY=your_api_key npx @ragieai/mcp-server --partition your_partition_id

# Using both options
RAGIE_API_KEY=your_api_key npx @ragieai/mcp-server --description "Search the company knowledge base" --partition your_partition_id

Cursor 配置

要在 Cursor 中使用此 MCP 服务：

选项 1：创建 MCP 配置文件

1. 保存名为 mcp.json 的文件

• 用于特定项目的工具，请在项目目录中创建 .cursor/mcp.json 文件。这样可以定义仅在该特定项目中可用的 MCP 服务。
• 用于所有项目的工具，请在你的主目录中创建 ~/.cursor/mcp.json 文件。这样 MCP 服务便可在所有 Cursor 工作区中使用。

mcp.json 示例：

{
  "mcpServers": {
    "ragie": {
      "command": "npx",
      "args": [
        "-y",
        "@ragieai/mcp-server",
        "--partition",
        "optional_partition_id"
      ],
      "env": {
        "RAGIE_API_KEY": "your_api_key"
      }
    }
  }
}

选项 2：使用 shell 脚本

1. 在系统中保存名为 ragie-mcp.sh 的文件：

#!/usr/bin/env bash

export RAGIE_API_KEY="your_api_key"

npx -y @ragieai/mcp-server --partition optional_partition_id

2. 为文件授予执行权限：chmod +x ragie-mcp.sh

3. 在 Cursor UI 中依次前往 Settings -> Cursor Settings -> MCP Servers，添加 MCP 服务脚本。

将 your_api_key 替换为你的实际 Ragie API 密钥，并根据需要设置分区 ID。

Claude Desktop 配置

要在 Claude 桌面应用中使用此 MCP 服务：

1. 创建 MCP 配置文件 claude_desktop_config.json：

• 对于 MacOS：使用 ~/Library/Application Support/Claude/claude_desktop_config.json
• 对于 Windows：使用 %APPDATA%/Claude/claude_desktop_config.json

claude_desktop_config.json 示例：

{
  "mcpServers": {
    "ragie": {
      "command": "npx",
      "args": [
        "-y",
        "@ragieai/mcp-server",
        "--partition",
        "optional_partition_id"
      ],
      "env": {
        "RAGIE_API_KEY": "your_api_key"
      }
    }
  }
}

将 your_api_key 替换为你的实际 Ragie API 密钥，并根据需要设置分区 ID。

2. 重启 Claude 桌面应用，使更改生效。

现在，Ragie 检索工具即可在 Claude 桌面应用的对话中使用。

功能

检索工具

此服务提供一个 retrieve 工具，可用于搜索知识库。它接受以下参数：

• query（字符串）：用于查找相关信息的搜索查询
• topK（数字，可选，默认值：8）：返回结果的最大数量
• rerank（布尔值，可选，默认值：true）：是否尝试仅查找最相关的信息
• recencyBias（布尔值，可选，默认值：false）：是否优先返回较新的信息

该工具返回：

• 包含知识库中匹配文本的内容块数组

开发

此项目使用 TypeScript 编写，主要依赖项如下：

• @modelcontextprotocol/sdk：用于实现 MCP 服务
• ragie：用于与 Ragie API 交互
• zod：用于运行时类型验证

开发环境设置

以开发模式运行服务：

RAGIE_API_KEY=your_api_key npm run dev -- --partition optional_partition_id

构建项目：

npm run build

许可证

MIT 许可证——详情请参阅 LICENSE.txt。