项目简介

Redis Cloud MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在通过标准化的 MCP 协议,使得用户可以使用自然语言与 Redis Cloud 云服务进行交互。借助 Claude Desktop 或 Cursor IDE 等 MCP 客户端,用户可以通过友好的自然语言指令,完成在 Redis Cloud 上的各种操作,例如创建数据库、查询订阅信息、管理云资源等。

主要功能点

  • 账户管理:
    • 获取当前 Redis Cloud 账户信息
    • 列出账户已配置的支付方式
  • 订阅管理:
    • 管理 Pro 和 Essential 两种类型的订阅
    • 支持列出、创建、删除订阅,以及按 ID 获取订阅详情
    • 支持多云部署、配置内存、持久化、模块等高级订阅选项
  • 数据库能力查询:
    • 列出当前账户支持的数据库模块和功能
  • 云服务商区域查询:
    • 获取云服务商 (AWS, GCP) 可用区域信息
  • 计划与定价查询:
    • 列出 Essential 订阅可用的服务计划
  • 任务管理:
    • 查看当前账户的任务列表
    • 按 ID 查询任务详情,跟踪部署状态和进度

安装步骤

  1. 安装 Node.js 和 npm: 确保你的开发环境已安装 Node.js (版本 v22.14.0) 和 npm (版本 10.9.2)。推荐使用 nvm (Node Version Manager) 管理 Node.js 版本。

  2. 克隆仓库: 将 'mcp-redis-cloud' 仓库克隆到本地。

    git clone https://github.com/redis/mcp-redis-cloud.git
    cd mcp-redis-cloud
  3. 安装依赖: 在项目根目录下运行 'npm install' 安装项目依赖。

    npm install
  4. 构建项目: 运行 'npm run build' 构建项目,生成可执行的 JavaScript 文件。

    npm run build

服务器配置

要将 Redis Cloud MCP Server 添加到 MCP 客户端(如 Claude Desktop 或 Cursor IDE),你需要配置服务器的启动命令和参数。以下是配置示例 (JSON 格式):

{
  "mcpServers": {
    "mcp-redis-cloud": {
      "command": "node",
      "args": ["--experimental-fetch", "<项目根目录的绝对路径>/dist/index.js"],
      "env": {
        "API_KEY": "<你的 Redis Cloud API Key>",
        "SECRET_KEY": "<你的 Redis Cloud Secret Key>"
      }
    }
  }
}

配置参数说明:

  • '"mcp-redis-cloud"': 服务器名称,可以自定义。
  • '"command": "node"': 启动服务器的命令,这里使用 Node.js 运行 JavaScript 文件。
  • '"args": ["--experimental-fetch", "<项目根目录的绝对路径>/dist/index.js"]': 命令参数,'--experimental-fetch' 是 Node.js 启用 fetch API 的实验性标志,'<项目根目录的绝对路径>/dist/index.js' 需要替换为 'dist/index.js' 文件在你本地文件系统中的绝对路径
  • '"env"': 环境变量配置。
    • '"API_KEY": "<你的 Redis Cloud API Key>"': 必须配置,替换为你的 Redis Cloud API Key。
    • '"SECRET_KEY": "<你的 Redis Cloud Secret Key>"': 必须配置,替换为你的 Redis Cloud Secret Key。

配置步骤:

  1. 获取 Redis Cloud API Key 和 Secret Key: 登录 Redis Cloud 控制台获取 API 凭据。
  2. 编辑 MCP 客户端配置文件:
    • Claude Desktop: 打开 Claude Desktop 设置,进入开发者选项卡(确保已启用开发者模式),点击 "Edit config",编辑 'claude_desktop_config.json' 文件,添加上述 JSON 配置。
    • Cursor IDE: 打开 Cursor 设置,导航到 MCP 选项卡,点击 "Add new global MCP Server",编辑自动打开的 'mcp.json' 文件,添加上述 JSON 配置。
  3. 重启 MCP 客户端: 重启 Claude Desktop 或 Cursor IDE 使配置生效。

基本使用方法

配置完成后,在 MCP 客户端中选择 "mcp-redis-cloud" 服务器,即可开始使用自然语言指令与 Redis Cloud 交互。

使用示例 (Claude Desktop 或 Cursor IDE):

  • "Create a new Redis database in AWS"
  • "What are my current subscriptions?"
  • "Help me choose the right Redis database for my e-commerce application"

请参考 Redis Cloud API 文档和项目代码,了解更详细的功能和使用方法。

信息

分类

数据库与文件