Supabase MCP Server (used By Deploya.dev)

🚀 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：監控項目整體健康狀態。

安全控制

統一安全模型

所有操作均採用統一的安全策略：

1. 用戶身份驗證：基於 JWT 的身份驗證，支持多種登錄方式。
2. 權限控制：細粒度的權限管理，確保最小化權限分配。
3. 審計日誌：記錄所有敏感操作，便於後續審查。

安全模式

• 安全模式：限制高風險操作，防止誤刪或數據洩露。
• 黑名單機制：預定義危險操作並默認阻止執行。
• 白名單機制：允許指定的安全操作在受限模式下執行。

事務處理

事務管理

支持以下事務功能：

1. 事務回滾：確保數據庫一致性，失敗時自動回滾。
2. 長事務優化：優化長事務的性能，減少鎖競爭。
3. 分佈式事務：支持多數據中心的事務協調。

📚 詳細文檔

安裝與配置

安裝 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 查詢，提升效率。

日誌記錄

詳細日誌輸出，便於調試和監控。

❓ 常見問題解答

1. 如何獲取項目引用（Project Ref）？ 請聯繫你的 Supabase 賬戶管理員獲取。
2. 遇到安全模式限制怎麼辦？ 請檢查你的權限設置，並聯系管理員調整安全策略。
3. 事務處理失敗怎麼辦？ 確保網絡穩定，檢查日誌輸出，必要時回滾事務。

🌟 總結

• 安裝簡單：通過 pip 安裝即可快速上手。
• 功能強大：集成多種實用工具，簡化開發流程。
• 安全可靠：內置完善的安全機制和事務管理。