Redis Cloud API MCP Server

Redis Cloud API MCP 服务

模型上下文协议（MCP）是一种标准化协议，用于管理大模型（LLM）与外部系统之间的上下文。本仓库提供了一个用于 Redis Cloud API 的 MCP 服务，让你能够使用自然语言管理 Redis Cloud 资源。

这让你可以通过 Claude Desktop 或任何 MCP 客户端，使用自然语言在 Redis Cloud 账户中完成操作，例如：

• “在 AWS 中创建一个新的 Redis 数据库”
• “我当前有哪些订阅？”
• “帮我为电子商务应用选择合适的 Redis 数据库”

功能

账户管理

• get_current_account：获取当前 Redis Cloud 账户的详细信息
• get_current_payment_methods：列出为账户配置的所有付款方式

订阅管理

Pro 订阅

• get_pro_subscriptions：列出账户中的所有 Pro 订阅
• create_pro_subscription：创建具有高级配置选项的新 Pro 订阅
  • 支持多云部署
  • 配置内存、持久化和模块
  • 设置 Active-Active 部署
  • 自定义网络配置

Essential 订阅

• get_essential_subscriptions：列出所有 Essential 订阅（分页）
• get_essential_subscription_by_id：获取特定 Essential 订阅的详细信息
• create_essential_subscription：创建新的 Essential 订阅
• delete_essential_subscription：删除 Essential 订阅

数据库能力

• get_database_modules：列出账户支持的所有可用数据库模块（功能）
  • Redis 模块
  • 数据库功能
  • 性能选项

云服务提供商管理

• get_pro_plans_regions：获取各云服务提供商的可用区域
  • AWS 区域
  • GCP 区域
  • 网络选项
  • 可用区

套餐与定价

• get_essentials_plans：列出可用的 Essential 订阅套餐（分页）
  • 支持 AWS、GCP 和 Azure
  • Redis Flex 选项
  • 固定套餐

任务管理

• get_tasks：列出账户中当前的所有任务
• get_task_by_id：获取特定任务的详细信息
  • 跟踪部署状态
  • 监控订阅变更
  • 查看任务进度

使用方法

前提条件

• 有效的 Redis Cloud API 凭据（API Key 和 Secret Key）
• 长时间运行的操作会返回任务 ID，可对其进行监控
• 分页响应需要多次调用才能获取所有数据

Claude Desktop

要在 Claude Desktop 中运行 MCP 服务，请按以下步骤操作：

1. 构建软件包：

   npm run build
   

2. 将服务添加到 Claude Desktop：

   • 打开 Claude Desktop 设置
   • 转到 Developer 选项卡（确保已启用 Developer Mode）
   • 点击“Edit config”
   • 在文本编辑器中打开 claude_desktop_config.json 文件，并添加以下配置：

   {
     "mcpServers": {
       "mcp-redis-cloud": {
         "command": "node",
         "args": ["--experimental-fetch", "<absolute_path_to_project_root>/dist/index.js"],
         "env": {
           "API_KEY": "<redis_cloud_api_key>",
           "SECRET_KEY": "<redis_cloud_api_secret_key>"
         }
       }
     }
   }
   

3. 关闭并重启 Claude Desktop。此时，服务应会显示在 MCP Servers 部分。

Cursor IDE

要在 Cursor IDE 中运行 MCP 服务，请按以下步骤操作：

1. 构建软件包：

   npm run build
   

2. 将服务添加到 Cursor：

   • 打开 Cursor 设置
   • 转到 MCP 选项卡
   • 点击“Add new global MCP Server”
   • 使用以下配置更新自动打开的 mcp.json 文件：

   {
     "mcpServers": {
       "mcp-redis-cloud": {
         "command": "node",
         "args": ["--experimental-fetch", "<absolute_path_to_project_root>/dist/index.js"],
         "env": {
           "API_KEY": "<redis_cloud_api_key>",
           "SECRET_KEY": "<redis_cloud_api_secret_key>"
         }
       }
     }
   }
   

3. 重启 Cursor。此时，服务应会显示在 MCP Servers 部分。

开发

前提条件

1. nvm（Node 版本管理器）
2. Node v22.14.0
3. npm 10.9.2

开始使用

1. 安装依赖：

   nvm use v22.14.0
   npm install
   

2. 构建项目：

   npm run build
   

3. 使用 MCP Inspector 测试：

   npx @modelcontextprotocol/inspector node dist/index.js --api-key=<api_key> --secret-key=<secret_key>
   

项目结构

src/
├── index.ts              # Entry point
├── clients/              # API Clients for external services
│   └── generated         # Generated Redis Cloud API client
└── tools/                # Tool implementations
    └── accounts/         # Account tools
    └── subscriptions/    # Subscription tools
    └── tasks/            # Task tools

注意：如果修改了代码，请记得重新构建并重启 Claude Desktop / Cursor：

npm run build

Docker 用法

构建 Docker 镜像

运行以下命令以构建 MCP 服务的 Docker 镜像：

docker build -t mcp/redis-cloud .

运行 Docker 容器

运行以下命令以启动容器：

docker run -i --rm \
  -e API_KEY=<your_redis_cloud_api_key> \
  -e SECRET_KEY=<your_redis_cloud_api_secret_key> \
  mcp/redis-cloud

将 Docker 与 Claude Desktop 集成

按照以下步骤，将 Docker 化的 MCP 服务与 Claude Desktop 集成：

1. 构建 Docker 镜像（如果尚未构建）：

   docker build -t mcp/redis-cloud .
   

2. 将服务添加到 Claude Desktop：

   • 打开 Claude Desktop 设置
   • 转到 Developer 选项卡（确保已启用 Developer Mode）
   • 点击“Edit config”
   • 在文本编辑器中打开 claude_desktop_config.json 文件
   • 添加以下配置：

   {
     "mcpServers": {
       "redis-cloud": {
         "command": "docker",
         "args": [
           "run",
           "-i",
           "--rm",
           "-e",
           "API_KEY=<your_redis_cloud_api_key>",
           "-e",
           "SECRET_KEY=<your_redis_cloud_api_secret_key>",
           "mcp/redis-cloud"
         ]
       }
     }
   }
   

3. 将占位值替换为实际的 API 凭据。

4. 保存配置文件并重启 Claude Desktop。

注意事项

• 确保已正确设置所需的环境变量（API_KEY、SECRET_KEY）。