使用说明
项目简介
Supabase MCP 服务器是一个基于 Model Context Protocol (MCP) 标准构建的应用后端,它充当 Supabase 项目和 AI 助手之间的桥梁。通过 MCP 协议,该服务器能够以标准化的方式向 Cursor、Claude、Windsurf 等 AI 助手提供 Supabase 项目的上下文信息和操作能力,例如项目管理、数据库操作、配置获取等。这使得 AI 助手可以直接与您的 Supabase 项目进行交互,从而实现更智能的应用开发和管理流程。
主要功能点
- 资源管理: 提供 OpenAPI 规范等资源,描述 PostgREST API 的能力,使 LLM 能够理解和利用 Supabase 的数据接口。
- 工具集成: 内置丰富的 Supabase 工具集,涵盖项目管理、数据库操作、项目配置和分支管理等多个方面,允许 LLM 通过调用这些工具来执行 Supabase 平台的各项任务。
- 标准化协议: 遵循 Model Context Protocol 标准,确保与各种兼容 MCP 协议的 LLM 客户端(如 Cursor 等)无缝对接。
- 灵活部署: 支持使用 'npx' 快速启动服务器,并提供详细的配置说明,方便用户在不同环境下部署和使用。
安装步骤
-
安装 Node.js: 确保您的机器上已安装 Node.js 运行环境。您可以通过在终端运行 'node -v' 命令来检查是否已安装。如果未安装,请访问 nodejs.org 下载并安装。
-
配置 MCP 客户端: 在您的 MCP 客户端(例如 Cursor)中,配置 Supabase MCP 服务器。通常,您需要提供服务器的启动命令和参数。
服务器配置
MCP 客户端需要配置 MCP 服务器的启动命令及其参数,以便建立连接。以下是 Supabase MCP 服务器的 JSON 格式配置信息示例,请根据您的 MCP 客户端进行配置:
{ "mcpServers": { "supabase": { "command": "npx", "args": [ "-y", "@supabase/mcp-server-supabase@latest", "--access-token", "<您的个人访问令牌>" ] } } }
参数说明:
- 'server name': 'supabase' (服务器名称,用于在 MCP 客户端中标识)
- 'command': 'npx' (启动命令,用于执行 Node.js 包)
- 'args': 启动参数列表,包括:
- '-y': 'npx' 参数,表示自动确认安装包
- '@supabase/mcp-server-supabase@latest': 要执行的 npm 包,即 Supabase MCP 服务器
- '--access-token': [必填] Supabase 个人访问令牌 (PAT),用于服务器鉴权。您需要在 Supabase 设置 中创建并替换 '<您的个人访问令牌>'。
Windows 平台配置:
如果您在 Windows 平台使用,可能需要在 'command' 中加入 'cmd /c' 前缀,或者使用 'wsl' 如果 Node.js 在 WSL 环境下:
Windows (cmd):
{ "mcpServers": { "supabase": { "command": "cmd", "args": [ "/c", "npx", "-y", "@supabase/mcp-server-supabase@latest", "--access-token", "<您的个人访问令牌>" ] } } }
Windows (WSL):
{ "mcpServers": { "supabase": { "command": "wsl", "args": [ "npx", "-y", "@supabase/mcp-server-supabase@latest", "--access-token", "<您的个人访问令牌>" ] } } }
请确保 Node.js 和 npm 已正确添加到您的系统 'PATH' 环境变量中。
基本使用方法
配置完成后,您的 MCP 客户端(如 Cursor)即可连接到 Supabase MCP 服务器。您可以通过客户端提供的界面或命令来调用服务器提供的工具,例如:
- 列出 Supabase 项目
- 获取项目详情
- 创建、暂停、恢复项目
- 执行 SQL 查询
- 应用数据库迁移
- 管理开发分支
- 获取项目 API 密钥 等
具体工具的使用方法和参数,请参考 MCP 客户端的文档和工具列表。
信息
分类
数据库与文件