Supabase MCP Server 使用说明

项目简介

Supabase MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器,旨在为AI模型提供对 Supabase Management API 的程序化访问能力。通过此服务器,AI模型可以方便地管理 Supabase 项目和组织,例如列出项目、获取项目详情、创建项目、删除项目,以及管理组织等。

主要功能点

  • 项目管理:
    • 列出所有项目
    • 获取项目详情
    • 创建新项目
    • 删除项目
    • 获取项目API密钥
  • 组织管理:
    • 列出所有组织
    • 获取组织详情
    • 创建新组织

这些功能通过工具 (Tools) 的形式暴露给 MCP 客户端,客户端可以通过调用这些工具来执行相应的 Supabase 管理操作。

安装步骤

  1. 环境准备: 确保已安装 Node.js 和 npm (或 yarn)。
  2. Claude 配置文件: 无需手动安装此服务器,因为它将作为 Claude 的 MCP 服务器直接运行。您只需要配置 Claude 的 JSON 配置文件 (通常是 'claude.jsonc' 或 'config.json')。

服务器配置 (MCP 客户端配置)

在 Claude 的配置文件中,您需要添加 'mcpServers' 字段来注册 Supabase MCP Server。以下是一个配置示例,您可以将其添加到您的 Claude 配置文件中:

{
  "mcpServers": {
    "supabase": {  // 服务器名称,可以自定义,例如 "supabase"
      "command": "npx", // 运行命令,通常为 "npx" 或 "node"
      "args": [       // 命令参数,指定要运行的 npm 包
        "y",          // (可选) 自动确认 npm 包安装
        "@joshuarileydev/supabase-mcp-server" // 要运行的 npm 包名称,即 Supabase MCP Server
      ],
      "env": {         // 环境变量
        "SUPABASE_API_KEY": "YOUR_SUPABASE_API_KEY" // 您的 Supabase API 密钥,**请替换为您的真实密钥**
      }
    }
  }
}

配置参数说明:

  • '"supabase"': 为该 MCP 服务器定义的名称,在 Claude 客户端中引用时使用。您可以自定义此名称。
  • '"command": "npx"': 指定用于启动服务器的命令。'npx' 允许您直接运行 npm 包,而无需全局安装。如果您的环境配置不同,也可以使用 '"node"' 并指向 'dist/index.js' 文件的路径。
  • '"args": [...]': 命令的参数列表。
    • '"y"': (可选) 传递给 'npx' 的参数,用于自动确认 npm 包的安装,避免在运行时出现交互式提示。
    • '"@joshuarileydev/supabase-mcp-server"': 指定要通过 'npx' 运行的 npm 包名称,这会下载并执行 Supabase MCP Server。
  • '"env": {...}': 设置服务器运行所需的环境变量。
    • '"SUPABASE_API_KEY": "YOUR_SUPABASE_API_KEY"': 非常重要! 您需要将 '"YOUR_SUPABASE_API_KEY"' 替换为您在 Supabase 控制台中生成的 API 密钥。此密钥用于服务器访问您的 Supabase 项目和组织。请务必妥善保管您的 API 密钥,避免泄露。

基本使用方法

配置完成后,Claude 或其他兼容 MCP 协议的客户端将能够发现并调用 Supabase MCP Server 提供的工具。

例如,在 Claude 中,您可以指示模型使用 'supabase' 服务器提供的工具来管理 Supabase 项目。模型会根据您的指令,自动调用相应的工具,并根据工具的输入要求,提取必要的参数。

示例对话 (Claude 客户端):

用户: "列出我所有的 Supabase 项目"

Claude (内部): 识别到用户需要列出 Supabase 项目,查询 'supabase' MCP 服务器的 'list_projects' 工具,并调用该工具。

Supabase MCP Server (收到请求): 调用 Supabase API 获取项目列表,并将结果返回给 Claude。

Claude (呈现给用户): 展示 Supabase 项目列表。

您可以通过类似的自然语言指令,利用 Claude 与 Supabase MCP Server 的集成,实现更多 Supabase 管理功能。

注意: 请确保您的 Supabase API 密钥具有执行您希望模型执行的操作所需的权限。

信息

分类

开发者工具