Ragie 知识库 MCP 服务器使用说明

项目简介

Ragie 知识库 MCP 服务器是一个实现了 Model Context Protocol (MCP) 协议的后端服务，旨在为大型语言模型 (LLM) 应用提供访问 Ragie 知识库检索能力的标准接口。该服务器通过 MCP 协议与客户端通信，提供单一但强大的 retrieve 工具，允许 LLM 应用查询 Ragie 知识库并获取相关信息，从而增强 LLM 的上下文理解和知识应用能力。

主要功能点

知识库检索: 提供 'retrieve' 工具，允许用户通过自然语言查询 Ragie 知识库，获取相关文档或信息片段。
MCP 协议标准: 完全遵循 Model Context Protocol 协议，保证与各类 MCP 客户端的兼容性和互操作性。
简单易用: 通过标准输入/输出 (stdio) 进行通信，易于部署和集成。
可配置: 支持通过命令行参数和环境变量进行灵活配置，例如自定义工具描述和指定 Ragie 分区。
支持 Cursor 和 Claude Desktop: 提供详细的配置指南，方便用户在 Cursor 代码编辑器和 Claude Desktop 应用中使用 Ragie 知识库检索功能。

安装步骤

安装 Node.js: 确保您的系统已安装 Node.js (版本 >= 18)。
获取 Ragie API 密钥: 您需要拥有一个 Ragie API 密钥才能使用此服务器。

安装 Ragie MCP 服务器: 使用 npm 包管理器全局安装 '@ragieai/mcp-server'。

npm install -g @ragieai/mcp-server

设置环境变量: 设置 'RAGIE_API_KEY' 环境变量为您的 Ragie API 密钥。例如，在 Linux/macOS 中，您可以执行 'export RAGIE_API_KEY=your_api_key'，在 Windows 中，您可以在系统环境变量中设置。

服务器配置

此 MCP 服务器需要配置在 MCP 客户端中才能使用。以下分别以 Cursor 和 Claude Desktop 为例，说明如何配置。

Cursor 配置 (mcp.json):

在 Cursor 的项目目录或用户目录 ('~/.cursor') 下创建 '.cursor/mcp.json' 文件，并添加以下配置信息。

{
  "mcpServers": {
    "ragie": {
      "command": "npx",
      "args": [
        "-y",
        "@ragieai/mcp-server",
        "--partition",
        "your_partition_id"  // (可选) 替换为您的 Ragie 分区 ID，如果不需要分区，可以删除此参数
      ],
      "env": {
        "RAGIE_API_KEY": "your_api_key" // 替换为您的 Ragie API 密钥
      }
    }
  }
}

配置参数说明:

'server name': 'ragie' (服务器名称，在 Cursor 中用于标识和选择该服务器)
'command': 'npx' (启动命令，用于执行 npm 包)
'args':
- '-y': 'npx' 参数，自动确认执行 npm 包
- '@ragieai/mcp-server': 要执行的 npm 包名称，即 Ragie MCP 服务器
- '--partition': (可选) 指定要查询的 Ragie 分区 ID，根据需要配置
'env':
- 'RAGIE_API_KEY': Ragie API 密钥，请务必替换为您的真实密钥

Claude Desktop 配置 (claude_desktop_config.json):

根据您的操作系统，在以下路径创建或编辑 'claude_desktop_config.json' 文件。

macOS: '~/Library/Application Support/Claude/claude_desktop_config.json'
Windows: '%APPDATA%/Claude/claude_desktop_config.json'

添加与 Cursor 类似的配置信息到 'claude_desktop_config.json' 文件中，配置参数说明与 Cursor 配置相同。

基本使用方法

配置完成后，在支持 MCP 协议的 LLM 客户端 (如 Cursor, Claude Desktop) 中，您可以通过自然语言指令调用 'ragie' 服务器提供的 'knowledge-base-retrieve' 工具。例如，您可以指示 LLM "使用知识库检索工具查找关于公司最新财报的信息" 或 "Use knowledge-base-retrieve to find information about company's latest financial report."。

'knowledge-base-retrieve' 工具接受一个 'query' 参数，用于指定您的搜索查询。工具将返回从 Ragie 知识库检索到的相关内容片段，LLM 可以利用这些信息来生成更准确和 context-aware 的回复。

示例工具调用 (JSON-RPC 请求，客户端自动生成):

{
  "jsonrpc": "2.0",
  "method": "tool_code_generation/execute",
  "params": {
    "tool_call_id": "工具调用ID",
    "tool_name": "knowledge-base-retrieve",
    "parameters": {
      "query": "公司最新的财务报告"
    }
  },
  "id": "请求ID"
}

命令行选项

启动 Ragie MCP 服务器时，您还可以使用以下命令行选项进行配置：

'--description, -d <text>': 自定义 'knowledge-base-retrieve' 工具的描述信息，用于在 LLM 客户端中展示。
'--partition, -p <id>': 指定要查询的 Ragie 知识库分区 ID。

例如:

RAGIE_API_KEY=your_api_key npx @ragieai/mcp-server --description "搜索公司知识库" --partition your_partition_id

关键词