🚀 Supabase MCP 服务器指南
本指南将详细介绍 Supabase MCP 服务器的安装、使用方法以及其丰富的功能特性，帮助你快速上手并高效使用该服务器。
🚀 快速开始
在 supabase-mcp 安装完成后，可以通过以下命令运行 MCP 服务器：
supabase-mcp run
默认情况下，MCP 服务器会在地址 http://localhost:3000 上运行。你可以通过访问该地址或使用 API 来与之交互。
📦 安装指南
通过以下命令安装最新的 Python 包：
pip install supabase-mcp
如果你需要特定版本，请参考 PyPI。
✨ 主要特性
数据库管理
SQL 查询工具
- send_sql_query：发送任意的 SQL 查询到 Supabase 数据库，支持以下功能：
- 自动注入项目引用（Project Ref）
- 安全模式控制
- 结果格式化为 Python 对象，支持属性访问（如
result.user.id）
数据库元数据
- get_sql_schema：获取完整的数据库架构信息。
- list_tables：列出所有表。
- describe_table：描述特定表的结构。
- list_columns：列出指定表的所有列。
项目管理
配额和使用情况
- get_usage_breakdown：获取详细的配额使用情况，按服务类型分类。
- get_project_limits：查看当前项目的各项限制配置。
- monitor_health：监控项目整体健康状态。
安全控制
统一安全模型
所有操作均采用统一的安全策略：
- 用户身份验证：基于 JWT 的身份验证，支持多种登录方式。
- 权限控制：细粒度的权限管理，确保最小化权限分配。
- 审计日志：记录所有敏感操作，便于后续审查。
安全模式
- 安全模式：限制高风险操作，防止误删或数据泄露。
- 黑名单机制：预定义危险操作并默认阻止执行。
- 白名单机制：允许指定的安全操作在受限模式下执行。
事务处理
事务管理
支持以下事务功能：
- 事务回滚：确保数据库一致性，失败时自动回滚。
- 长事务优化：优化长事务的性能，减少锁竞争。
- 分布式事务：支持多数据中心的事务协调。
📚 详细文档
安装与配置
安装 MCP 服务器
pip install supabase-mcp
配置 MCP 服务器
创建 config.yaml 文件：
server:
port: 3000
host: localhost
auth:
secret_key: your-secret-key-here
使用说明
基本用法
启动 MCP 服务器：
supabase-mcp run --config config.yaml
访问控制台：
supabase-mcp console
进阶功能
批量操作
支持批量处理 SQL 查询，提升效率。
日志记录
详细日志输出，便于调试和监控。
❓ 常见问题解答
- 如何获取项目引用（Project Ref）？ 请联系你的 Supabase 账户管理员获取。
- 遇到安全模式限制怎么办？ 请检查你的权限设置，并联系管理员调整安全策略。
- 事务处理失败怎么办？ 确保网络稳定，检查日志输出，必要时回滚事务。
🌟 总结
- 安装简单：通过 pip 安装即可快速上手。
- 功能强大：集成多种实用工具，简化开发流程。
- 安全可靠：内置完善的安全机制和事务管理。