Redis Cloud

Interaja com a API do Redis Cloud para gerenciar seus bancos de dados Redis.

Documentação

Servidor MCP da API Redis Cloud

O Model Context Protocol (MCP) é um protocolo padronizado para gerenciar contexto entre grandes modelos de linguagem (LLMs) e sistemas externos. Este repositório fornece um Servidor MCP para a API do Redis Cloud, permitindo que você gerencie seus recursos do Redis Cloud usando linguagem natural.

Isso permite que você use o Claude Desktop, ou qualquer Cliente MCP, para usar linguagem natural e realizar tarefas na sua conta do Redis Cloud, por exemplo:

  • "Crie um novo banco de dados Redis na AWS"
  • "Quais são minhas assinaturas atuais?"
  • "Ajude-me a escolher o banco de dados Redis certo para minha aplicação de e-commerce"

Recursos

Gerenciamento de Conta

  • get_current_account: Obtenha detalhes sobre sua conta atual do Redis Cloud
  • get_current_payment_methods: Liste todos os métodos de pagamento configurados para sua conta

Gerenciamento de Assinaturas

Assinaturas Pro

  • get_pro_subscriptions: Liste todas as assinaturas Pro na sua conta
  • create_pro_subscription: Crie uma nova assinatura Pro com opções avançadas de configuração
    • Suporte a implantação multi-nuvem
    • Configure memória, persistência e módulos
    • Configure implantações Active-Active
    • Configuração personalizada de rede

Assinaturas Essential

  • get_essential_subscriptions: Liste todas as assinaturas Essential (paginadas)
  • get_essential_subscription_by_id: Obtenha informações detalhadas sobre uma assinatura Essential específica
  • create_essential_subscription: Crie uma nova assinatura Essential
  • delete_essential_subscription: Exclua uma assinatura Essential

Recursos de Banco de Dados

  • get_database_modules: Liste todos os módulos de banco de dados (recursos) disponíveis suportados na sua conta
    • Módulos Redis
    • Recursos de banco de dados
    • Opções de desempenho

Gerenciamento de Provedores de Nuvem

  • get_pro_plans_regions: Obtenha regiões disponíveis entre provedores de nuvem
    • Regiões AWS
    • Regiões GCP
    • Opções de rede
    • Zonas de disponibilidade

Planos e Preços

  • get_essentials_plans: Liste os planos de assinatura Essential disponíveis (paginados)
    • Suporte a AWS, GCP e Azure
    • Opções Redis Flex
    • Planos fixos

Gerenciamento de Tarefas

  • get_tasks: Liste todas as tarefas atuais na sua conta
  • get_task_by_id: Obtenha informações detalhadas sobre uma tarefa específica
    • Acompanhe o status da implantação
    • Monitore alterações na assinatura
    • Visualize o progresso da tarefa

Uso

Pré-requisitos

  • Credenciais válidas da API do Redis Cloud (Chave de API e Chave Secreta)
  • IDs de tarefas são retornados para operações de longa duração e podem ser monitorados
  • Respostas paginadas exigem múltiplas chamadas para recuperar todos os dados

Claude Desktop

Para executar o servidor MCP com o Claude Desktop, siga estes passos:

  1. Compile o pacote:

    npm run build
    
  2. Adicione o servidor ao Claude Desktop:

    • Abra as configurações do Claude Desktop
    • Navegue até a aba Desenvolvedor (certifique-se de ter ativado o Modo Desenvolvedor)
    • Clique em "Editar configuração"
    • Abra o arquivo claude_desktop_config.json no seu editor de texto e adicione a seguinte configuração:
    {
      "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. Feche o Claude Desktop e reinicie-o. O servidor agora deve estar disponível na seção Servidores MCP.

IDE Cursor

Para executar o servidor MCP com o IDE Cursor, siga estes passos:

  1. Compile o pacote:

    npm run build
    
  2. Adicione o servidor ao Cursor:

    • Abra as Configurações do Cursor
    • Navegue até a aba MCP
    • Clique em "Adicionar novo Servidor MCP global"
    • Atualize o arquivo mcp.json aberto automaticamente com a seguinte configuração:
    {
      "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. Reinicie o Cursor. O servidor agora deve estar disponível na seção Servidores MCP.

Desenvolvimento

Pré-requisitos

  1. nvm (Node Version Manager)
  2. Node v22.14.0
  3. npm 10.9.2

Começando

  1. Instale as dependências:

    nvm use v22.14.0
    npm install
    
  2. Compile o projeto:

    npm run build
    
  3. Teste usando o MCP Inspector:

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

Estrutura do Projeto

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

Nota: Se você fizer alterações no seu código, lembre-se de recompilar e reiniciar o Claude Desktop / Cursor:

npm run build

Uso com Docker

Construindo a Imagem Docker

Para construir a imagem Docker para o servidor MCP, execute o seguinte comando:

docker build -t mcp/redis-cloud .

Executando o Contêiner Docker

Para executar o contêiner, use o seguinte comando:

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

Integração Docker com Claude Desktop

Para integrar o servidor MCP conteinerizado com o Claude Desktop, siga estes passos:

  1. Construa a imagem Docker (se ainda não o fez):

    docker build -t mcp/redis-cloud .
    
  2. Adicione o servidor ao Claude Desktop:

    • Abra as configurações do Claude Desktop
    • Navegue até a aba Desenvolvedor (certifique-se de que o Modo Desenvolvedor esteja ativado)
    • Clique em "Editar configuração"
    • Abra o arquivo claude_desktop_config.json no seu editor de texto
    • Adicione a seguinte configuração:
    {
      "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. Substitua os valores de exemplo pelas suas credenciais reais da API.

  4. Salve o arquivo de configuração e reinicie o Claude Desktop.

Notas

  • Certifique-se de que as variáveis de ambiente necessárias (API_KEY, SECRET_KEY) estejam configuradas corretamente.