Supabase MCP Server (used By Deploya.dev)

🚀 Supabase MCP Server Guide

This guide provides a comprehensive overview of the Supabase MCP server, including installation, quick start, feature modules, and detailed usage instructions.

🚀 Quick Start

After installing supabase-mcp, you can run the MCP server with the following command:

supabase-mcp run

By default, the MCP server runs at http://localhost:3000. You can access this address or use the API to interact with it.

✨ Features

Database Management

SQL Query Tool

• send_sql_query: Send any SQL query to the Supabase database, supporting the following features:
  • Automatic injection of the Project Ref.
  • Security mode control.
  • Format results as Python objects, supporting attribute access (e.g., result.user.id).

Database Metadata

• get_sql_schema: Get the complete database schema information.
• list_tables: List all tables.
• describe_table: Describe the structure of a specific table.
• list_columns: List all columns of a specified table.

Project Management

Quota and Usage

• get_usage_breakdown: Get detailed quota usage, categorized by service type.
• get_project_limits: View the current project's various limit configurations.
• monitor_health: Monitor the overall health status of the project.

Security Control

Unified Security Model

All operations adopt a unified security strategy:

1. User Authentication: JWT-based authentication, supporting multiple login methods.
2. Permission Control: Fine-grained permission management to ensure minimal permission allocation.
3. Audit Logs: Record all sensitive operations for subsequent review.

Security Modes

• Security Mode: Restrict high-risk operations to prevent accidental deletion or data leakage.
• Blacklist Mechanism: Pre-define dangerous operations and block their execution by default.
• Whitelist Mechanism: Allow specified safe operations to be executed in restricted mode.

Transaction Handling

Transaction Management

Supports the following transaction features:

1. Transaction Rollback: Ensure database consistency and automatically roll back on failure.
2. Long Transaction Optimization: Optimize the performance of long transactions and reduce lock contention.
3. Distributed Transactions: Support transaction coordination across multiple data centers.

📦 Installation

Install the latest Python package with the following command:

pip install supabase-mcp

If you need a specific version, please refer to PyPI.

💻 Usage Examples

Basic Usage

Start the MCP server:

supabase-mcp run --config config.yaml

Access the console:

supabase-mcp console

Advanced Usage

Batch Operations

Support batch processing of SQL queries to improve efficiency.

Logging

Detailed log output for easy debugging and monitoring.

📚 Documentation

Installation and Configuration

Install the MCP Server

pip install supabase-mcp

Configure the MCP Server

Create a config.yaml file:

server:
  port: 3000
  host: localhost

auth:
  secret_key: your-secret-key-here

📄 Summary

• Easy Installation: Quickly get started by installing via pip.
• Powerful Features: Integrate various practical tools to simplify the development process.
• Secure and Reliable: Built-in comprehensive security mechanisms and transaction management.

❓ Frequently Asked Questions

1. How to get the Project Ref? Contact your Supabase account administrator.

2. What if I encounter security mode restrictions? Check your permission settings and contact the administrator to adjust the security policy.

3. What if transaction processing fails? Ensure network stability, check the log output, and roll back the transaction if necessary.