Upstash MCP Server 使用说明

项目简介

Upstash MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器,它允许你使用自然语言命令,通过 MCP 客户端(如 Claude Desktop)管理你的 Upstash 数据库和服务。它充当了大型语言模型(LLM)和 Upstash API 之间的桥梁,使得用户可以通过更自然的方式与 Upstash 服务进行交互。

主要功能点

  • Upstash API 工具化: 将 Upstash API 的各项功能封装成可供 LLM 调用的工具,例如创建、删除、列出 Redis 数据库,创建和恢复备份等。
  • Redis 数据库管理: 提供全面的 Redis 数据库管理功能,包括数据库的创建、删除、详情查看、密码重置、区域更新等。
  • Redis 备份管理: 支持 Redis 数据库的备份和恢复操作,包括创建备份、删除备份、列出备份和设置每日备份。
  • Redis 命令执行: 允许用户通过自然语言执行 Redis 命令,方便进行数据查询和操作。
  • 性能监控: 提供 Redis 数据库的性能统计信息,如延迟、吞吐量、内存使用情况等。
  • 标准化协议: 基于 Model Context Protocol (MCP) 构建,保证了与 MCP 客户端的兼容性和互操作性。

安装步骤

  1. 环境准备: 确保已安装 Node.js (>= v18.0.0) 和 Claude Desktop,并拥有 Upstash 开发者 API 的 API 密钥和邮箱。
  2. 使用 npx 安装: 在终端中运行以下命令,初始化 Upstash MCP Server。请将 '<UPSTASH_EMAIL>' 和 '<UPSTASH_API_KEY>' 替换为你的 Upstash 账户邮箱和 API 密钥。
    npx @upstash/mcp-server init <UPSTASH_EMAIL> <UPSTASH_API_KEY>
  3. 重启 Claude Desktop: 安装完成后,重启 Claude Desktop 客户端,以加载 Upstash MCP Server 的配置。

服务器配置

Upstash MCP Server 需要配置到 MCP 客户端(如 Claude Desktop)中才能使用。'init' 命令会自动完成配置。以下是 Claude Desktop 所需的服务器配置 JSON 示例(无需手动配置,仅供参考):

{
  "upstash": { // "upstash" 是服务器名称,可以自定义
    "command": "npx", // 启动服务器的命令,这里使用 npx 运行 npm 包
    "args": ["@upstash/mcp-server", "run", "<UPSTASH_EMAIL>", "<UPSTASH_API_KEY>"] // 传递给命令的参数
    //   "@upstash/mcp-server":  MCP 服务器的 npm 包名
    //   "run":                  指定 MCP 服务器运行的操作是 "run" (启动服务器)
    //   "<UPSTASH_EMAIL>":      你的 Upstash 账户邮箱 (请替换为你的实际邮箱)
    //   "<UPSTASH_API_KEY>":    你的 Upstash API 密钥 (请替换为你的实际 API 密钥)
  }
}

基本使用方法

完成安装和配置后,你就可以在 Claude Desktop 中使用自然语言指令来管理你的 Upstash 服务了。例如:

  • 创建一个新的 Redis 数据库:'Create a new Redis database in us-east-1'
  • 列出所有数据库:'List all databases'
  • 查看数据库 "mydb" 的详细信息:'Get details of database mydb'
  • 创建数据库 "mydb" 的备份,命名为 "backup-20241027":'Create a backup of database mydb named backup-20241027'

更多功能可以通过自然语言探索和使用。

信息

分类

数据库与文件