Ragie MCP Server

🚀 Ragie 模型上下文協議服務器

Ragie 模型上下文協議服務器實現了模型上下文協議 (MCP)，為 AI 模型提供訪問 Ragie 知識庫檢索功能的能力，助力模型從知識庫中獲取所需信息。

🚀 快速開始

Ragie 模型上下文協議服務器實現了 Model Context Protocol，讓 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.json 文件

在項目根目錄下創建一個 mcp.json 文件，並添加以下內容：

{
  "servers": [
    {
      "name": "ragie-mcp-server",
      "url": "http://localhost:3000"
    }
  ]
}

方法二：編寫 Shell 腳本

創建一個 shell 腳本（例如 start_mcp_server.sh），並添加以下內容：

#!/bin/bash
RAGIE_API_KEY=your_api_key npx @ragieai/mcp-server --partition your_partition_id

然後賦予腳本執行權限：

chmod +x start_mcp_server.sh

運行腳本以啟動服務器。

Claude 桌面配置

要在 Claude 桌面中添加此服務器，請找到以下路徑並編輯對應的配置文件：

• Windows：C:\Users\<YourUsername>\.claudius\config\mcp.json
• macOS/Linux：~/.claudius/config/mcp.json

在文件中添加以下內容：

{
  "servers": [
    {
      "name": "ragie-mcp-server",
      "url": "http://localhost:3000"
    }
  ]
}

替換 <YourUsername> 和 your_api_key 為您的實際信息，並可選地添加 --partition your_partition_id 參數。

🔧 技術細節

項目使用 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，詳情請參閱 LICENSE.txt 文件。