Supabase MCP

🚀 Supabase MCP 服务器

Supabase MCP 服务器可将您的 Supabase 项目与 Cursor、Claude、Windsurf 等 AI 助手相连接，借助模型上下文协议（MCP），标准化大型语言模型（LLMs）与 Supabase 等外部服务的通信，使 LLMs 能直接连接您的 Supabase 项目，执行项目管理、数据库操作和代码生成等操作。

🚀 快速开始

模型上下文协议 (MCP) 标准化了大型语言模型（LLMs）与外部服务（如 Supabase）之间的通信方式。它使 LLMs 能够直接连接到您的 Supabase 项目，并执行各种操作，例如管理项目、执行数据库操作和生成代码。

✨ 主要特性

• 实现 Supabase 项目与多种 AI 助手的连接。
• 借助 MCP 协议，让 LLMs 可直接对 Supabase 项目进行操作。
• 提供丰富的工具集，涵盖项目管理、数据库操作、项目配置等多方面功能。

📦 安装指南

先决条件

在开始之前，请确保您具备以下条件：

• 一个有效的 Supabase 账户。
• 安装并配置了 Node.js 和 npm。
• 熟悉命令行界面（CLI）。

设置

创建个人访问令牌

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 工具及其功能：

项目管理

• 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 迁移到数据库中。LLMs 应使用此工具进行 DDL 操作（模式更改）。
• execute_sql：执行原始 SQL 查询。LLMs 可以使用此工具进行常规查询，而不更改架构。
• get_logs：获取指定服务类型的项目日志（api、postgres、边缘函数、身份验证、存储、实时）。LLMs 可以使用此工具帮助调试和服务性能监控。

项目配置

• get_project_url：获取项目的 API URL。
• get_anon_key：获取项目的匿名 API 密钥。

分支（实验性，需要付费计划）

• create_branch：从生产分支创建开发分支。
• list_branches：列出所有开发分支。
• delete_branch：删除指定的开发分支。
• merge_branch：将开发分支的迁移和边缘函数合并到生产环境。
• reset_branch：重置开发分支的迁移历史到先前版本。
• rebase_branch：基于生产分支重新生成开发分支，以解决迁移漂移问题。

开发工具

• generate_typescript_types：根据数据库架构生成 TypeScript 类型。LLMs 可以将此内容保存到文件中，并在代码中使用。

成本确认

• get_cost：获取新项目或分支的成本估算。
• confirm_cost：确认用户对新项目或分支成本的理解。这是创建新项目或分支的必要步骤。

📚 详细文档

其他 MCP 服务器

@supabase/mcp-server-postgrest

PostgREST MCP 服务器允许您通过 REST API 将自己的用户连接到应用程序。有关更多详细信息，请参见其项目 README。

资源

• 模型上下文协议：了解 MCP 及其功能的更多信息。

📄 许可证

该项目在 Apache 2.0 许可证下。更多内容请参见LICENSE文件。