Redis云API管理服务

一个基于MCP协议的服务,允许通过自然语言管理Redis Cloud资源,包括账户、订阅、数据库和云提供商管理。

  • by redis
  • TypeScript
  • 本地部署
  • 33 星标
  • 更新于
在 GitHub 查看 redis/mcp-redis-cloud

使用说明

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:列出为您的帐户配置的所有付款方式

订阅管理

专业订阅

  • get_pro_subscriptions:列出您帐户中的所有Pro订阅
  • create_pro_subscription:使用高级配置选项创建新的Pro订阅
    • 支持多云部署
    • 配置内存、持久性和模块
    • 设置主动-主动部署
    • 自定义网络配置

基本订阅

  • get_essential_subscriptions:列出所有基本订阅(分页)
  • get_essential_subscription_by_id:获取特定Essential订阅的详细信息
  • create_essential_subscription:创建新的Essential订阅
  • delete_essential_subscription:删除基本订阅

数据库功能

  • get_database_modules:列出您的帐户中支持的所有可用数据库模块(功能)
    • Redis模块
    • 数据库功能
    • 性能选项

云提供商管理

  • get_pro_plans_regions:跨云提供商获取可用区域
    • AWS区域
    • GCP地区
    • 网络选项
    • 可用区

方案与价格

  • get_essentials_plans:列出可用的基本订阅计划(分页)
    • 支持AWS、GCP和Azure
    • Redis Flex选项
    • 固定计划

任务管理

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

用法

先决条件

  • 有效的Redis Cloud API凭据(API密钥和密钥)
  • 长时间运行的操作会返回任务ID,并且可以对其进行监控
  • 分页响应需要多次调用才能检索所有数据

克劳德桌面

要使用Claude Desktop运行MCP服务器,请执行以下步骤:

  1. 构建包:

    npm run build
    
  2. 将服务器添加到Claude Desktop:

    • 打开克劳德桌面设置
    • 导航到“开发人员”选项卡(确保已启用“开发人员模式”)
    • 点击“编辑配置”
    • 打开 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服务器部分可用。

光标IDE

要使用Cursor IDE运行MCP服务器,请执行以下步骤:

  1. 构建包:

    npm run build
    
  2. 将服务器添加到游标:

    • 打开光标设置
    • 导航到MCP选项卡
    • 点击“添加新的全局MCP服务器”
    • 更新自动打开的 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. 重新启动游标。现在,服务器应该可以在MCP服务器部分中使用。

发展

先决条件

  1. nvm(节点版本管理器)
  2. 节点v22.14.0
  3. npm 10.9.2

入门指南

  1. 安装依赖项:

    nvm use v22.14.0
    npm install
    
  2. 构建项目:

    npm run build
    
  3. 使用MCP检查器进行测试:

    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/Coursor:

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_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)设置正确。