Upstash MCP Server 使用说明

项目简介

Upstash MCP Server 是一个基于 Model Context Protocol (MCP) 的服务器实现,旨在连接大型语言模型 (LLM) 客户端(如 Claude Desktop)和 Upstash Developer API。它允许用户通过自然语言指令,利用 LLM 客户端操作和管理 Upstash 上的服务,例如创建 Redis 数据库、管理备份、查看数据库使用情况等。

主要功能点

  • 自然语言操作 Upstash 服务: 通过 Claude Desktop 等 MCP 客户端,使用自然语言指令管理 Upstash 资源。
  • Upstash Redis 数据库管理: 支持对 Upstash Redis 数据库进行全面的管理操作,包括创建、删除、备份、恢复、密码重置、配置更新以及监控数据库使用情况等。
  • 丰富的 Redis 工具集: 提供创建数据库、删除数据库、列出数据库、获取数据库详情、更新数据库区域、重置密码、获取使用统计数据、创建备份、删除备份、恢复备份、列出备份、设置每日备份、运行 Redis 命令等多种工具。
  • MCP 标准协议: 遵循 Model Context Protocol 标准,使用 JSON-RPC 协议与 MCP 客户端通信,保证了良好的兼容性和互操作性。
  • Stdio 传输协议: 支持 Stdio 传输协议,方便与各种 MCP 客户端集成。

安装步骤

  1. 环境准备: 确保已安装 Node.js (>= v18.0.0) 和 Claude Desktop 等 MCP 客户端。
  2. 获取 Upstash API 密钥: 访问 Upstash 控制台 获取您的 API 密钥 (API Key)邮箱 (Email)
  3. 初始化配置: 在命令行终端中运行初始化命令,将 '<UPSTASH_EMAIL>' 和 '<UPSTASH_API_KEY>' 替换为您的 Upstash 邮箱和 API 密钥:
    npx @upstash/mcp-server-upstash init <UPSTASH_EMAIL> <UPSTASH_API_KEY>
  4. 重启客户端: 重启 Claude Desktop 或其他 MCP 客户端,使配置生效。

服务器配置

  • MCP 客户端需要配置 MCP 服务器的启动命令才能连接 Upstash MCP Server。以下是 Claude Desktop 等客户端所需的服务器配置信息(JSON 格式):

    {
      "upstash": {
        "command": "npx",
        "args": ["@upstash/mcp-server-upstash", "run", "<UPSTASH_EMAIL>", "<UPSTASH_API_KEY>"]
      }
    }

    配置参数说明:

    • 'server name': 'upstash' (服务器名称,用于在客户端配置中标识 Upstash MCP Server)
    • 'command': 'npx' (启动命令,使用 npx 运行 npm 包)
    • 'args': '["@upstash/mcp-server-upstash", "run", "<UPSTASH_EMAIL>", "<UPSTASH_API_KEY>"]' (命令参数数组)
      • '"@upstash/mcp-server-upstash"': 指定要运行的 npm 包名称
      • '"run"': Upstash MCP Server 的 'run' 命令,用于启动服务器
      • '<UPSTASH_EMAIL>': [请替换为您的 Upstash 邮箱]
      • '<UPSTASH_API_KEY>': [请替换为您的 Upstash API 密钥]

    注意: '<UPSTASH_EMAIL>' 和 '<UPSTASH_API_KEY>' 不是 配置 JSON 中的字面量,您需要将它们替换成您真实的 Upstash 邮箱和 API 密钥。 初始化命令 'npx @upstash/mcp-server-upstash init ...' 通常会自动完成客户端的配置,无需手动修改 JSON 文件。

基本使用方法

  1. 启动客户端: 启动 Claude Desktop 或其他已配置 Upstash MCP Server 的 MCP 客户端。
  2. 自然语言指令: 在客户端中,您可以使用自然语言指令来操作 Upstash 服务。例如:
    • 创建 Redis 数据库: 'Create a new Redis database named my-db in us-east-1'
    • 列出所有数据库: 'List all my databases'
    • 查看数据库使用量: 'Show me the usage of database my-db'
    • 创建数据库备份: 'Create a backup for my-db named backup-oct-27'

信息

分类

数据库与文件