article
README
🚀 Redis 云 API MCP 服务器
模型上下文协议(MCP)是一种标准化协议,用于在大型语言模型(LLMs)和外部系统之间管理上下文。本仓库提供了一个基于 Redis Cloud API 的 MCP 服务器,让您能够使用自然语言管理 Redis Cloud 资源。
借助此服务器,您可以使用 Claude Desktop 或任何 MCP 客户端,通过自然语言在 Redis Cloud 账户上完成各类任务,例如:
- "创建 AWS 上的新 Redis 数据库"
- "我的当前订阅有哪些?"
- "帮我选择适合我电子商务应用程序的 Redis 数据库"
🚀 快速开始
入门指南
- 安装依赖:
- 确保已安装 Node.js 和 TypeScript。
- 安装所需依赖项,如
@types/node、express和typescript。
- 配置 API 密钥:
- 在环境变量中设置
REDIS_CLOUD_API_KEY和REDIS_CLOUD_SECRET_KEY。
- 在环境变量中设置
- 运行服务器:
npm start
项目结构
src/
├── index.ts # 入口点
├── clients/ # 外部服务 API 客户端
│ └── generated # 自动生成的 Redis Cloud API 客户端
└── tools/ # 工具实现
└── accounts/ # 账号工具
└── subscriptions/ # 订阅工具
└── tasks/ # 任务工具
Docker 使用
构建 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
集成到 Claude Desktop
- 构建 Docker 镜像(如果尚未构建):
docker build -t mcp/redis-cloud .
- 添加服务器到 Claude Desktop:
- 打开 Claude Desktop 设置。
- 导航到开发者选项卡(确保已启用开发人员模式)。
- 点击“编辑配置”。
- 打开
claude_desktop_config.json文件。 - 添加以下配置:
{
"mcpServers": {
"redis-cloud": {
"command": "docker",
"args": [
"run",
"-i"
✨ 主要特性
账号管理
get_current_account:获取当前 Redis Cloud 账户的详细信息。get_current_payment_methods:列出账户中配置的所有付款方式。
订阅管理
Pro 订阅
get_pro_subscriptions:列出账户中的所有 Pro 订阅。create_pro_subscription:创建新的 Pro 订阅,支持高级配置选项,包括:- 支持多云部署。
- 配置内存、持久性和模块。
- 设置主动 --active 部署。
- 自定义网络配置。
必要订阅
get_essential_subscriptions:列出所有必要订阅(分页)。get_essential_subscription_by_id:获取特定必要订阅的详细信息。create_essential_subscription:创建新的必要订阅。delete_essential_subscription:删除必要的订阅。
数据库功能
get_database_modules:列出账户中支持的所有数据库模块(功能),包括:- Redis 模块。
- 数据库功能。
- 性能选项。
云提供商管理
get_pro_plans_regions:获取所有 Pro 计划的区域信息,包括:- AWS 区域。
- GCP 区域。
- 网络选项。
- 可用性区域。
计划和定价
get_essentials_plans:列出可用的必要订阅计划(分页),支持 AWS、GCP 和 Azure,包含 Redis Flex 选项和固定计划。
任务管理
get_tasks:列出账户中的所有当前任务。get_task:获取特定任务的详细信息。create_task:创建新任务。update_task:更新现有任务。delete_task:删除任务。
Scan to join WeChat group