使用说明

项目简介

Ragie TypeScript MCP服务器是一个基于Model Context Protocol (MCP) 的后端实现，它不仅提供了一套用于与 Ragie API 交互的 TypeScript SDK，同时也能作为一个独立的 MCP 服务器运行。这个服务器允许AI应用通过 MCP 协议调用 SDK 中暴露的功能，作为工具使用，从而为LLM应用提供上下文服务。

主要功能点

资源管理: 支持对文档 (Documents)、连接 (Connections) 和分区 (Partitions) 等资源进行管理和访问。
工具注册与执行: SDK 中的各种方法被自动注册为工具，可供LLM客户端调用，例如创建文档、检索信息、管理连接等。
隐式Prompt模板: 通过 SDK 提供的各种方法，间接支持 Prompt 模板，LLM 可以根据需要调用不同的 SDK 方法来获取上下文信息，从而实现定制化的交互模式。
会话管理与能力声明: MCP 服务器端负责会话管理，并通过 MCP 协议向客户端声明其提供的能力（即 SDK 中暴露的工具）。
多种传输协议支持: 虽然文档中没有明确指出，但作为 MCP 服务器，理论上支持 Stdio, SSE, WebSocket 等传输协议（具体支持情况需查看仓库代码或详细文档）。

安装步骤

环境准备: 确保已安装 Node.js v20 或更高版本。
安装 Ragie SDK: 使用 npm, pnpm, bun 或 yarn 等包管理器安装 'ragie' 包。例如使用 npm：
```
npm add ragie
```

服务器配置

MCP 客户端（例如 Claude 或 Cursor）需要配置 MCP 服务器的启动信息才能连接。配置信息通常是 JSON 格式。以下是根据仓库信息生成的 Claude 和 Cursor 的配置示例，您需要根据实际情况进行调整。

Claude 配置 (添加到 'claude_desktop_config.json'):

{
  "mcpServers": {
    "Ragie": {
      "command": "npx",
      "args": [
        "-y", "--package", "ragie",
        "--",
        "mcp", "start",
        "--api-auth", "<YOUR_API_AUTH_TOKEN>"
      ]
    }
  }
}

参数说明:

'"Ragie"': 服务器名称，可以自定义。
'"command": "npx"': 指定启动命令为 'npx'，用于执行 npm 包。
'"args": [...]': 启动参数列表：
- '"-y", "--package", "ragie"': 使用 'npx' 执行 'ragie' 包，'-y' 表示自动确认安装包。
- '" -- "': 分隔 'npx' 参数和 'ragie' 包的参数。
- '"mcp", "start"': 'ragie' 包的命令，指示启动 MCP 服务器。
- '"--api-auth", "<YOUR_API_AUTH_TOKEN>"': 'mcp start' 命令的参数，用于设置 API 鉴权 token，请替换 '<YOUR_API_AUTH_TOKEN>' 为您的实际 API token。

Cursor 配置 (创建 '.cursor/mcp.json'):

{
  "mcpServers": {
    "Ragie": {
      "command": "npx",
      "args": [
        "-y", "--package", "ragie",
        "--",
        "mcp", "start",
        "--api-auth", "<YOUR_API_AUTH_TOKEN>"
      ]
    }
  }
}

参数说明: 与 Claude 配置相同，请务必替换 '<YOUR_API_AUTH_TOKEN>' 为您的实际 API token。

注意:

'--api-auth' 参数用于 API 鉴权，您需要替换 '<YOUR_API_AUTH_TOKEN>' 为您的 Ragie API 的有效 token。
您可以运行 'npx -y --package ragie -- mcp start --help' 命令查看 'mcp start' 命令的完整参数列表，以便根据需要进行更详细的配置。

基本使用方法

启动 MCP 服务器: 按照上述配置，在 Claude 或 Cursor 中添加 Ragie MCP 服务器配置后，启动 Claude 或 Cursor，MCP 服务器将随之启动。
LLM 客户端调用工具: 在 Claude 或 Cursor 等 MCP 客户端中，您可以像调用其他工具一样调用 Ragie MCP 服务器提供的工具。工具名称将对应 SDK 中暴露的方法，例如 'ragie.documents.create' 方法会作为一个名为 'documentsCreate' 的工具暴露出来。
利用工具获取上下文: 在 LLM 的 Prompt 中，您可以指示 LLM 调用 Ragie MCP 服务器提供的工具来获取文档、连接或分区等信息，并将这些信息作为上下文用于后续的 LLM 任务。

示例 (LLM Prompt 示意):

请帮我总结一下名为 "example.file" 的文档的内容。你可以使用 "Ragie/documentsGetSummary" 工具来获取文档摘要。

注意: 具体的工具调用方式和参数需要参考 MCP 客户端（如 Claude, Cursor）的文档。

关键词