Supabase MCP Server 使用教程
1. 项目介绍
Supabase MCP Server 是一个开源项目,旨在将 Supabase 数据库项目与 AI 助手(如 Cursor、Claude、Windsurf 等)连接起来。它通过 Model Context Protocol (MCP) 标准化了大型语言模型 (LLMs) 与外部服务(如 Supabase)的通信方式,使得 AI 助手可以直接与 Supabase 项目交互,执行如管理表格、获取配置信息以及查询数据等任务。
2. 项目快速启动
环境准备
在开始之前,请确保您的机器上已经安装了 Node.js。您可以通过运行 node -v
命令来检查安装情况。如果没有安装 Node.js,可以从 nodejs.org 下载安装。
创建个人访问令牌 (PAT)
- 访问您的 Supabase 设置页面,创建一个新的个人访问令牌(PAT)。为令牌命名,以便描述其用途,例如 "Cursor MCP Server"。
- 复制该令牌,因为您将无法再次查看它。
配置 MCP 客户端
接下来,配置您的 MCP 客户端(如 Cursor)以使用这个服务器。大多数 MCP 客户端将配置存储为 JSON 格式,如下所示:
{
"mcpServers": {
"supabase": {
"command": "npx",
"args": [
"-y",
"@supabase/mcp-server-supabase@latest",
"--access-token",
"<personal-access-token>"
]
}
}
}
将 <personal-access-token>
替换为您在步骤 1 中创建的令牌。或者,您可以省略 --access-token
并将个人访问令牌设置为环境变量 SUPABASE_ACCESS_TOKEN
(在将配置提交到仓库时,这样做可以避免版本控制中的令牌)。
如果是 Windows 用户,需要在命令前加上 cmd /c
:
{
"mcpServers": {
"supabase": {
"command": "cmd",
"args": [
"/c",
"npx",
"-y",
"supabase/mcp-server-supabase@latest",
"--access-token",
"<personal-access-token>"
]
}
}
}
如果是使用 WSL 在 Windows 上运行 Node.js,可以使用以下配置:
{
"mcpServers": {
"supabase": {
"command": "wsl",
"args": [
"npx",
"-y",
"supabase/mcp-server-supabase@latest",
"--access-token",
"<personal-access-token>"
]
}
}
}
确保 Node.js 可在系统的 PATH
环境变量中使用。如果是 Windows 用户,可以在终端运行以下命令来设置:
- 获取
npm
路径:npm config get prefix
- 将目录添加到
PATH
:setx PATH "%PATH%;<path-to-dir>"
重启您的 MCP 客户端。
3. 应用案例和最佳实践
- 项目配置:使用
get_project_url
和get_anon_key
方法来获取项目的 API URL 和匿名 API key,以便在应用中使用。 - 数据库操作:通过
list_tables
、list_extensions
和list_migrations
方法来获取数据库的结构信息。 - 项目分支管理:使用
create_branch
和merge_branch
等方法来管理开发分支和版本迁移。
4. 典型生态项目
- @supabase/mcp-server-postgrest:允许您通过 REST API 连接自己的用户到应用程序。
以上是 Supabase MCP Server 的基本使用教程,希望对您有所帮助。