详细介绍
Supabase MCP Server 是一个标准化协议(MCP)的实现,允许大型语言模型(LLMs)直接与 Supabase 项目交互。通过该服务器,开发者可以管理数据库、获取项目配置、执行 SQL 查询、生成 TypeScript 类型等,从而实现 AI 与 Supabase 的无缝集成。
核心功能
Supabase MCP Server 提供了丰富的功能,涵盖项目管理、数据库操作、项目配置、开发工具和成本估算等多个方面。以下是主要功能:
- 项目管理:包括列出所有项目、获取项目详情、创建新项目、暂停或恢复项目、列出组织等。
- 数据库操作:支持列出表、扩展、迁移,执行 SQL 查询,应用迁移脚本,获取服务日志等。
- 项目配置:可获取项目的 API URL 和匿名 API 密钥。
- 开发工具:基于数据库架构生成 TypeScript 类型,便于代码开发。
- 成本估算:获取新项目或分支的成本估算,并确认成本。
- 分支管理(实验性):创建、列出、删除、合并、重置和重新生成开发分支。
安装方法
在安装 Supabase MCP Server 之前,请确保已安装 Node.js 和 npm,并拥有一个有效的 Supabase 账户。
创建个人访问令牌
1. 登录 Supabase 控制台。
2. 进入“设置” > “安全” > “访问控制”。
3. 点击“创建令牌”,为令牌命名(例如:mcp-server-token)。
4. 选择所需权限,点击“创建”。
配置 MCP 客户端
将以下配置保存为 `config.json` 文件,并填写您的 Supabase 账户信息:
{
"supabaseUrl": "https://your-supabase-project-id.supabase.co",
"apiKey": "your-anon-key-here",
"mcpToken": "your-mcp-server-token-here"
}使用方法
在配置好 MCP 客户端后,可以通过命令行启动 Supabase MCP Server,并与 AI 助手进行交互。
验证连接
运行以下命令验证是否成功连接到 Supabase MCP Server:
npx -y @supabase/mcp-server-supabase@latest --access-token=常用命令
以下是几个常用的 MCP 命令示例:
- 列出所有项目:`list_projects`
- 执行 SQL 查询:`execute_sql`,需提供 SQL 语句作为参数
使用示例
以下是两个典型的使用场景:
查询所有表格
用户可以向 AI 助手发送如下指令:
请列出我的 Supabase 项目中的所有表格。AI 助手将调用 `list_tables` 命令,并返回一个包含所有表格名称的列表。
生成 TypeScript 类型
用户可以发送如下指令:
生成我数据库的 TypeScript 类型。AI 助手将调用 `generate_typescript_types` 命令,基于数据库架构生成 TypeScript 类型,并保存到指定文件中。
使用场景
Supabase MCP Server 适用于希望利用 AI 助手与 Supabase 项目集成的开发人员和团队。无论是日常任务自动化,还是复杂的数据分析和项目管理,都可以从中受益。
注意事项
部分高级功能(如分支管理)需要付费计划支持。此外,该工具依赖于稳定的网络连接以确保实时通信。
Supabase MCP Server 通过标准化的 MCP 协议,为 AI 与 Supabase 之间的交互提供了强大支持,是提升开发效率和自动化能力的重要工具。