mcp/redis-cloud

Verified Publisher

By mcp

Updated about 1 year ago

MCP Server for Redis Cloud's API, allowing you to manage your Redis Cloud resources using natural...

Image
Machine learning & AI
1

9.9K

mcp/redis-cloud repository overview

Redis Cloud MCP Server

MCP Server for Redis Cloud's API, allowing you to manage your Redis Cloud resources using natural language.

What is an MCP Server?

MCP Info

Image Building Info

AttributeDetails
Dockerfilehttps://github.com/redis/mcp-redis-cloud/blob/015aaa6bfeec87198a08eaae00352348d4db4b72/Dockerfile
Commit015aaa6bfeec87198a08eaae00352348d4db4b72
Docker Image built byDocker Inc.
Docker Scout Health ScoreDocker Scout Health Score
Verify SignatureCOSIGN_REPOSITORY=mcp/signatures cosign verify mcp/redis-cloud --key https://raw.githubusercontent.com/docker/keyring/refs/heads/main/public/mcp/latest.pub
LicenceMIT License

Available Tools (18)

Tools provided by this ServerShort Description
create-essential-databaseCreate a new essential database inside the specified subscription ID.
create-essential-subscriptionCreate a new essential subscription.
create-pro-databaseCreate a new database inside the specified subscription ID.
create-pro-subscriptionCreate a new pro subscription.
delete-essential-subscriptionDelete an essential subscription by ID
get-current-accountGet the current Cloud Redis account
get-current-payment-methodsGet the current payment methods for the current Cloud Redis account
get-database-modulesLookup list of database modules supported in current account (support may differ based on subscription and database settings).
get-essential-databasesGet the essential databases for the provided subscription Id
get-essential-subscription-by-idGet an essential subscription by ID for the current Cloud Redis account
get-essential-subscriptionsGet the essential subscriptions for the current Cloud Redis account.
get-essentials-plansGet the available plans for essential subscriptions.
get-pro-databasesGet the pro databases for the provided subscription Id
get-pro-plans-regionsLookup list of regions for cloud provider.
get-pro-subscriptionGet pro subscription by ID.
get-pro-subscriptionsGet the pro subscriptions for the current Cloud Redis account
get-task-by-idGet a task by ID for the current Cloud Redis account
get-tasksGet the current tasks for the current Cloud Redis account

Tools Details

Tool: create-essential-database

Create a new essential database inside the specified subscription ID. Returns a TASK ID that can be used to track the status of the database creation. IMPORTANT GUIDELINES: 1) DO NOT set optional parameters unless explicitly requested. 2) Modules can only be selected if protocol is 'redis'. 3) When creating a free database, first call the get-essential-subscriptions tool to check if a free database already exists (each account is limited to one free database). 4) For database modules, validate against get-database-modules list. 5) The payload must match the input schema.

ParametersTypeDescription
namestringRequired. Name of the database. Database name is limited to 40 characters or less and must include only letters, digits, and hyphens ('-'). It must start with a letter and end with a letter or digit.
subscriptionIdnumberSubscription ID
dataEvictionPolicystring optionalOptional. Data items eviction method. Default: 'volatile-lru'
dataPersistencestring optionalOptional. Rate of database data persistence (in persistent storage). The default is according to the subscription plan.
datasetSizeInGbnumber optionalOptional. The maximum amount of data in the dataset for this specific database is in GB. If 'replication' is true, the database's total memory will be twice as large as the datasetSizeInGb. If 'replication' is false, the database's total memory will be the datasetSizeInGb value.
enableDatabaseClusteringboolean optionalOptional. Distributes database data to different cloud instances. Supported only for 'Pay-As-You-Go' subscriptions.
enableTlsboolean optionalOptional. When 'true', requires TLS authentication for all connections (mTLS with valid clientTlsCertificates, regular TLS when the clientTlsCertificates is not provided. Default: 'false'
modulesarray optionalOptional. Redis modules to be provisioned in the database. Use get-database-modules to retrieve available modules and configure the desired ones. IMPORTANT: Modules can only be used when protocol is 'redis'. Cannot use modules with 'memcached' or 'stack' protocols.
numberOfShardsinteger optionalOptional. Specifies the number of master shards. Supported only for 'Pay-As-You-Go' subscriptions.
passwordstring optionalOptional. Password to access the database. If omitted, a random 32 character long alphanumeric password will be automatically generated. Can only be set if Database Protocol is REDIS
periodicBackupPathstring optionalOptional. If specified, automatic backups will be every 24 hours or database will be able to perform immediate backups to this path. If empty string is received, backup path will be removed.
protocolstring optionalOptional. Database protocol. Default: 'redis' for Pay-As-You-Go subscriptions, 'stack' for Redis Flex subscriptions
replicationboolean optionalOptional. Databases replication. The default is according to the subscription plan.
respVersionstring optionalOptional. RESP version must be compatible with Redis version.
sourceIpsarray optionalOptional. List of source IP addresses or subnet masks. If specified, Redis clients will be able to connect to this database only from within the specified source IP addresses ranges.
supportOSSClusterApiboolean optionalOptional. Support Redis open-source (OSS) Cluster API. Supported only for 'Pay-As-You-Go' subscriptions. Default: 'false'
useExternalEndpointForOSSClusterApiboolean optionalOptional. Should use external endpoint for open-source (OSS) Cluster API. Can only be enabled if OSS Cluster API support is enabled. Supported only for 'Pay-As-You-Go' subscriptions.

Tool: create-essential-subscription

Create a new essential subscription. Returns a TASK ID that can be used to track the status of the subscription creation

ParametersTypeDescription
namestringSubscription name
planIdnumberPlan ID. The plan ID can be taken from /fixed/plans
paymentMethodstring optionalPayment method
paymentMethodIdnumber optionalPayment method ID

Tool: create-pro-database

Create a new database inside the specified subscription ID. Returns a TASK ID that can be used to track the status of the database creationPrerequisites: 1) For database modules, validate against get-database-modules list. 2) Validate regions using get-pro-plans-regions. The payload must match the input schema.

ParametersTypeDescription
namestringRequired. Name of the database. Database name is limited to 40 characters or less and must include only letters, digits, and hyphens ('-'). It must start with a letter and end with a letter or digit.
subscriptionIdnumberSubscription ID
averageItemSizeInBytesinteger optionalOptional. Relevant only to ram-and-flash subscriptions. Estimated average size (measured in bytes) of the items stored in the database, Default: 1000
dataEvictionPolicystring optionalOptional. Data items eviction method. Default: 'volatile-lru'
dataPersistencestring optionalOptional. Rate of database data persistence (in persistent storage). Default: 'none'
datasetSizeInGbnumber optionalOptional. The maximum amount of data in the dataset for this specific database is in GB. You can not set both datasetSizeInGb and totalMemoryInGb. if 'replication' is true, the database's total memory will be twice as large as the datasetSizeInGb.if 'replication' is false, the database's total memory of the database will be the datasetSizeInGb value.
dryRunboolean optionalOptional. When 'false': Creates a deployment plan and deploys it (creating any resources required by the plan). When 'true': creates a read-only deployment plan without any resource creation. Default: 'true'
enableTlsboolean optionalOptional. When 'true', requires TLS authentication for all connections (mTLS with valid clientSslCertificate, regular TLS when the clientSslCertificate is not provided. Default: 'false'
modulesarray optionalOptional. Redis modules to be provisioned in the database. Use get-database-modules to retrieve available modules and configure the desired ones
passwordstring optionalOptional. Password to access the database. If omitted, a random 32 character long alphanumeric password will be automatically generated. Can only be set if Database Protocol is REDIS
portinteger optionalOptional. TCP port on which the database is available (10000-19999). Generated automatically if omitted
protocolstring optionalOptional. Database protocol. Default: 'redis'
queryPerformanceFactorstring optionalOptional. The query performance factor adds extra compute power specifically for search and query.
replicationboolean optionalOptional. Databases replication. Default: 'true'
respVersionstring optionalOptional. RESP version must be compatible with Redis version.
saslPasswordstring optionalOptional. Memcached (SASL) Password to access the database. If omitted, a random 32 character long alphanumeric password will be automatically generated. Can only be set if Database Protocol is MEMCACHED
saslUsernamestring optionalOptional. Memcached (SASL) Username to access the database. If omitted, the username will be set to a 'mc-' prefix followed by a random 5 character long alphanumeric. Can only be set if Database Protocol is MEMCACHED
shardingTypestring optionalOptional. Database Hashing policy.
sourceIparray optionalOptional. List of source IP addresses or subnet masks. If specified, Redis clients will be able to connect to this database only from within the specified source IP addresses ranges.
supportOSSClusterApiboolean optionalOptional. Support Redis open-source (OSS) Cluster API. Default: 'false'
throughputMeasurementobject optionalOptional. Throughput measurement method.

Tool: create-pro-subscription

Create a new pro subscription. Returns a TASK ID that can be used to track the status of the subscription creation. Prerequisites: 1) Verify payment method by checking get-current-payment-methods. 2) For database modules, validate against get-database-modules list. 3) Validate regions using get-pro-plans-regions. The payload must match the input schema.

ParametersTypeDescription
cloudProvidersarrayRequired. Cloud hosting & networking details. Make sure to validate this before submitting the subscription.
databasesarrayRequired. Databases specifications for each planned database. Make sure to validate this before submitting the subscription.
deploymentTypestring optionalOptional. When 'single-region' or null: Creates a single region subscription. When 'active-active': creates an active-active (multi-region) subscription
dryRunboolean optionalOptional. When 'false': Creates a deployment plan and deploys it (creating any resources required by the plan). When 'true': creates a read-only deployment plan without any resource creation. Default: 'false'
memoryStoragestring optionalOptional. Memory storage preference: either 'ram' or a combination of 'ram-and-flash'. Default: 'ram'
namestring optionalOptional. Subscription name
paymentMethodstring optionalRequired. The payment method for the requested subscription. If 'credit-card' is specified, 'paymentMethodId' must be defined. Default: 'credit-card. Validate this before submitting the subscription.
paymentMethodIdinteger optionalRequired if paymentMethod is credit-card. A valid payment method that was pre-defined in the current account. This value is Optional if 'paymentMethod' is 'marketplace', but Required for all other account types. Validate this before submitting the subscription.
redisVersionstring optionalOptional. If specified, the redisVersion defines the Redis version of the databases in the subscription. If omitted, the Redis version will be the default

Tool: delete-essential-subscription

Delete an essential subscription by ID

ParametersTypeDescription
subscriptionIdnumberSubscription ID

Tool: get-current-account

Get the current Cloud Redis account

Tool: get-current-payment-methods

Get the current payment methods for the current Cloud Redis account

Tool: get-database-modules

Lookup list of database modules supported in current account (support may differ based on subscription and database settings). These modules are also called capabilities.

Tool: get-essential-databases

Get the essential databases for the provided subscription Id

ParametersTypeDescription
subscriptionIdnumberSubscription ID
limitnumber optionalOptional. Maximum number of items to return
offsetnumber optionalOptional. Number of items to skip

Tool: get-essential-subscription-by-id

Get an essential subscription by ID for the current Cloud Redis account

ParametersTypeDescription
subscriptionIdnumberSubscription ID

Tool: get-essential-subscriptions

Get the essential subscriptions for the current Cloud Redis account. A paginated response is returned, and to get all the essential subscriptions, the page and size parameters must be used until all the essential subscriptions are retrieved.

ParametersTypeDescription
pagenumber optionalPage number
sizenumber optionalPage size

Tool: get-essentials-plans

Get the available plans for essential subscriptions. Always ask for which provider the plans are want to be retrieved. A paginated response is returned, and to get all the plans, the page and size parameters must be used until all the plans are retrieved.

ParametersTypeDescription
providerstringProvider name.
pagenumber optionalPage number
redisFlexboolean optionalRedis Flex
sizenumber optionalPage size

Tool: get-pro-databases

Get the pro databases for the provided subscription Id

ParametersTypeDescription
subscriptionIdnumberSubscription ID
limitnumber optionalOptional. Maximum number of items to return
offsetnumber optionalOptional. Number of items to skip

Tool: get-pro-plans-regions

Lookup list of regions for cloud provider. These regions include the providers too.

Tool: get-pro-subscription

Get pro subscription by ID. The payload must match the input schema.

ParametersTypeDescription
subscriptionIdnumberSubscription ID

Tool: get-pro-subscriptions

Get the pro subscriptions for the current Cloud Redis account

Tool: get-task-by-id

Get a task by ID for the current Cloud Redis account

ParametersTypeDescription
taskIdstringTask ID

Tool: get-tasks

Get the current tasks for the current Cloud Redis account

Use this MCP Server

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

Why is it safer to run MCP Servers with Docker?

Install from MCP:Hub

Tag summary

Content type

Image

Digest

sha256:ebea14d11

Size

55.5 MB

Last updated

about 1 year ago

docker pull mcp/redis-cloud

This week's pulls

Pulls:

1,401

Last week