Supabase MCP Server Fqq

🚀 在 IDE 中配置 Supabase MCP 服务器指南

本指南将详细介绍如何在 IDE 中配置 Supabase MCP 服务器，帮助您提升开发效率。

📦 安装指南

使用 pip 安装

在终端中运行以下命令以安装 supabase-mcp-server：

pip install supabase-mcp-server

验证安装

安装完成后，可以通过运行以下命令验证是否安装成功：

supabase-mcp-server --version

如果显示版本号，则表示安装成功。

🛠️ 配置指南

通用配置步骤

1. 获取 Supabase 账户信息

   • 登录 Supabase 控制台
   • 进入项目设置，找到 anon_key 和 api_key

2. 创建 MCP 配置文件

   • 在项目根目录下创建一个名为 .supabase_mcp.json 的文件
   • 添加以下内容：

{
    "region": "asia-1",  // 根据你的区域选择正确的区域
    "project_ref": "your_project_ref",
    "db_url": "postgresql://localhost:5432/your_database_name"
}

VSCode 配置

1. 安装扩展

   • 在 VSCode 中，进入扩展市场，搜索并安装 Supabase MCP Server 扩展

2. 配置设置

   • 打开 VSCode 的设置（Ctrl + ,）
   • 搜索 supabase mcp server
   • 填写 project_ref, anon_key, 和 api_key

3. 启动服务器

   • 在命令面板中运行：Supabase: Start MCP Server

IntelliJ IDEA 配置

1. 安装插件

   • 打开 IDEA，进入 File > Settings > Plugins
   • 搜索并安装 Supabase MCP Server 插件

2. 配置设置

   • 进入 File > Settings > Tools > Supabase MCP Server
   • 填写 project_ref, anon_key, 和 api_key

3. 启动服务器

   • 右键点击项目目录，选择 Supabase: Start MCP Server

💻 使用示例

数据库查询工具

从 v0.3.0 版本开始，服务器支持读写模式和只读模式的 SQL 查询。

基础用法

以下是一些可用工具及其功能：

• get_db_schemas：列出所有数据库架构及其大小和表数量
• get_tables：列出架构中的所有表格及其大小、行数和元数据
• get_table_schema：获取表的详细结构，包括列、键和关系
• execute_sql_query：执行带有验证的原始 SQL 查询

高级用法

• 模式支持：
  • 只读模式：默认情况下仅允许只读查询
  • 读写模式：需要显式切换以启用所有操作，切换命令：supabase-mcp-server --mode=read-write

管理 API 工具

从 v0.3.0 版本开始，支持通过管理 API 发送任意请求，并带有自动注入的项目标识符和安全模式控制。

基础用法

以下是一些可用工具及其功能：

• send_management_api_request：发送到 Supabase 管理 API 的任意请求，带有自动注入的项目标识符和安全模式控制
• get_api_keys：获取项目的 API 密钥

高级用法

• 安全模式支持：
  • 默认模式：仅允许读取操作
  • 开发者模式：启用写入操作，需谨慎使用

❓ 故障排除

常见问题

1. 无法连接到数据库
   • 检查 db_url 是否正确
   • 确保数据库服务正在运行
2. 权限问题
   • 确保使用的 API 密钥具有足够权限
3. 版本不兼容
   • 确认 supabase-mcp-server 版本与 Supabase 服务版本匹配

联系支持

• 提交 issue 到 GitHub 仓库
• 加入 Supabase 社区论坛寻求帮助

🚧 未来规划

计划功能

• 支持更多区域的 MCP 服务器
• 增加对 MongoDB 的支持
• 实现更精细的安全策略

贡献指南

• 欢迎提交 PR 和 issue
• 参与 GitHub 仓库 开发

通过以上步骤，您可以轻松配置并使用 Supabase MCP 服务器，提升开发效率。