Supabase MCP 服务器允许大型语言模型 (LLM) 直接与 Supabase 项目交互,无需人工干预。借助 Model Context Protocol (MCP),LLM 能够安全地执行复杂数据库操作、管理边缘函数以及配置项目设置等。
Supabase MCP 服务器为大型语言模型与 Supabase 项目的交互提供了便利,以下是使用该服务器的基本步骤。
确保你已经安装了 Node.js 和 npm:
npm install -g node
从你的 Supabase 项目中获取 anon 公共密钥和管理密钥。
在终端中运行以下命令以启动 MCP 服务器:
npx supabase-mcp-server --anon-key=your_anon_key --api-key=your_api_key
⚠️ 重要提示
此服务器处于 pre - 1.0 阶段,可能会有一些破坏性更改。不过由于 LLM 会自动适应可用的工具,因此这对大多数用户来说影响不大。
💡 使用建议
generate_typescript_types工具可以生成基于数据库模式的 TypeScript 类型。LLM 可以将这些类型保存到文件中并在代码中使用。
以下是可用于 LLM 的 Supabase 工具列表:
注意:如果服务器已 作用域于特定项目,则以下工具不可用。
list_projects:列出用户的所有 Supabase 项目。get_project:获取指定项目的详细信息。create_project:创建新的 Supabase 项目。pause_project:暂停指定项目。restore_project:恢复已暂停的项目。list_organizations:列出用户所属的所有组织。get_organization:获取指定组织的详细信息。list_tables:列出特定模式中的所有表。list_extensions:列出数据库中的所有扩展。list_migrations:列出数据库中的所有迁移。apply_migration:将 SQL 迁移到数据库中。LLM 应该使用此工具进行 DDL 操作(架构更改)。execute_sql:执行数据库的原始 SQL 查询。LLM 应该使用此工具进行常规查询,而不更改架构。get_logs:根据服务类型获取 Supabase 项目的日志(api、postgres、边缘函数、身份验证、存储、实时)。LLM 可以使用此工具帮助调试和监控服务性能。list_edge_functions:列出项目中的所有边缘函数。deploy_edge_function:部署新的边缘函数到 Supabase 项目。LLM 可以使用此工具来部署新功能或更新现有功能。get_project_url:获取项目的 API URL。get_anon_key:获取项目的匿名 API 密钥。create_branch:从生产分支创建新的开发分支。list_branches:列出所有项目分支。switch_branch:切换到指定分支。delete_branch:删除指定分支。用于通过 REST API 接口与 PostgreSQL 数据库交互的 MCP 服务器。
本项目受 MIT 许可证 保护。