Ragieai Ragie MCP Server

🚀 Ragie 模型上下文协议服务器

Ragie 模型上下文协议服务器实现了模型上下文协议（MCP），为 AI 模型提供从 Ragie 知识库检索信息的能力，让信息获取更高效。

🚀 快速开始

Ragie 模型上下文协议服务器实现了模型上下文协议，可使 AI 模型从 Ragie 知识库中检索信息。它提供了名为“retrieve”的单一工具，用于查询知识库获取相关信息。

✨ 主要特性

• 实现模型上下文协议（MCP），赋予 AI 模型从 Ragie 知识库检索信息的能力。
• 提供“retrieve”工具，方便查询知识库。

📦 安装指南

先决条件

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

环境变量

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

• RAGIE_API_KEY（必需）：您的 Ragie API 认证密钥

安装命令

使用 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

💻 使用示例

光标配置

要将此 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. 运行脚本：

./ragie-mcp.sh

🔧 技术细节

此项目使用 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。