https://github.com/redis/mcp-redis-cloud
https://github.com/redis/mcp-redis-cloud
Last synced: 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/redis/mcp-redis-cloud
- Owner: redis
- License: mit
- Created: 2025-03-28T10:18:18.000Z (3 months ago)
- Default Branch: main
- Last Pushed: 2025-04-08T07:31:13.000Z (2 months ago)
- Last Synced: 2025-04-08T08:32:58.735Z (2 months ago)
- Language: TypeScript
- Size: 161 KB
- Stars: 9
- Watchers: 5
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- mcp-index - Redis Cloud API - Manage Redis Cloud resources through natural language commands, enabling users to create databases, monitor subscriptions, and configure cloud deployments effortlessly. Provides quick access to account details, payment methods, and subscription status. (Cloud Services)
README
# Redis Cloud API MCP Server
Model Context Protocol (MCP) is a standardized protocol for managing context between large language models (LLMs) and external systems. This repository provides an MCP Server for Redis Cloud's API, allowing you to manage your Redis Cloud resources using natural language.
This lets you use Claude Desktop, or any MCP Client, to use natural language to accomplish things on your Redis Cloud account, e.g.:
- "Create a new Redis database in AWS"
- "What are my current subscriptions?"
- "Help me choose the right Redis database for my e-commerce application"
## Features
### Account Management
- `get_current_account`: Get details about your current Redis Cloud account
- `get_current_payment_methods`: List all payment methods configured for your account
### Subscription Management
#### Pro Subscriptions
- `get_pro_subscriptions`: List all Pro subscriptions in your account
- `create_pro_subscription`: Create a new Pro subscription with advanced configuration options
- Supports multi-cloud deployment
- Configure memory, persistence, and modules
- Set up Active-Active deployments
- Custom networking configuration
#### Essential Subscriptions
- `get_essential_subscriptions`: List all Essential subscriptions (paginated)
- `get_essential_subscription_by_id`: Get detailed information about a specific Essential subscription
- `create_essential_subscription`: Create a new Essential subscription
- `delete_essential_subscription`: Delete an Essential subscription
### Database Capabilities
- `get_database_modules`: List all available database modules (capabilities) supported in your account
- Redis modules
- Database features
- Performance options
### Cloud Provider Management
- `get_pro_plans_regions`: Get available regions across cloud providers
- AWS regions
- GCP regions
- Networking options
- Availability zones
### Plans and Pricing
- `get_essentials_plans`: List available Essential subscription plans (paginated)
- Supports AWS, GCP, and Azure
- Redis Flex options
- Fixed plans
### Task Management
- `get_tasks`: List all current tasks in your account
- `get_task_by_id`: Get detailed information about a specific task
- Track deployment status
- Monitor subscription changes
- View task progress
## Usage
#### Prerequisites
- Valid Redis Cloud API credentials (API Key and Secret Key)
- Task IDs are returned for long-running operations and can be monitored
- Paginated responses require multiple calls to retrieve all data
### Claude Desktop
To run the MCP server with Claude Desktop, follow these steps:
1. Build the package:
```bash
npm run build
```
2. Add the server to Claude Desktop:
- Open Claude Desktop settings
- Navigate to the Developer tab (make sure you have enabled Developer Mode)
- Click on "Edit config"
- Open the `claude_desktop_config.json` file in your text editor and add the following configuration:
```json
{
"mcpServers": {
"mcp-redis-cloud": {
"command": "node",
"args": ["--experimental-fetch", "/dist/index.js"],
"env": {
"API_KEY": "",
"SECRET_KEY": ""
}
}
}
}
```
3. Close Claude Desktop and restart it. The server should now be available in the MCP Servers section.
### Cursor IDE
To run the MCP server with Cursor IDE, follow these steps:
1. Build the package:
```bash
npm run build
```
2. Add the server to Cursor:
- Open Cursor Settings
- Navigate to the MCP tab
- Click on "Add new global MCP Server"
- Update the automatically opened `mcp.json` file with the following configuration:
```json
{
"mcpServers": {
"mcp-redis-cloud": {
"command": "node",
"args": ["--experimental-fetch", "/dist/index.js"],
"env": {
"API_KEY": "",
"SECRET_KEY": ""
}
}
}
}
```
3. Restart Cursor. The server should now be available in the MCP Servers section.
## Development
### Prerequisites
1. nvm (Node Version Manager)
2. Node v22.14.0
3. npm 10.9.2
### Getting Started
1. Install dependencies:
```bash
nvm use v22.14.0
npm install
```
2. Build the project:
```bash
npm run build
```
3. Test it by using the MCP Inspector:
```bash
npx @modelcontextprotocol/inspector node dist/index.js --api-key= --secret-key=
```
### Project Structure
```
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
```
Note: If you make changes to your code, remember to rebuild and restart Claude Desktop / Cursor:
```bash
npm run build
```