Ragie 模型上下文协议服务器

一个模型上下文协议 (MCP) 服务器，提供对 Ragie 知识库检索功能的访问。

描述

此服务器实现了模型上下文协议，使 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

示例：

# 使用自定义描述
RAGIE_API_KEY=your_api_key npx @ragieai/mcp-server --description "搜索公司知识库以获取信息"

# 指定分区
RAGIE_API_KEY=your_api_key npx @ragieai/mcp-server --partition your_partition_id

# 同时使用两个选项
RAGIE_API_KEY=your_api_key npx @ragieai/mcp-server --description "搜索公司知识库" --partition your_partition_id

Cursor 配置

要将此 MCP 服务器与 Cursor 一起使用：

选项 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 配置

要将此 MCP 服务器与 Claude desktop 一起使用：

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 desktop 以使更改生效。

Ragie 检索工具现在将在您的 Claude desktop 对话中可用。

功能

Retrieve 工具

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

• query (string): 用于查找相关信息的搜索查询
• topK (number, optional, default: 8): 要返回的最大结果数
• rerank (boolean, optional, default: true): 是否尝试仅查找最相关的信息
• recencyBias (boolean, optional, default: 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。