Supabase MCP Server Fqq

🚀 Guide to Configuring Supabase MCP Server in IDE

This guide provides a step-by-step process for installing, configuring, and using the Supabase MCP Server in your IDE. It also includes troubleshooting tips and future development plans.

📦 Installation

Install via pip

Run the following command in your terminal to install supabase-mcp-server:

pip install supabase-mcp-server

Verify Installation

After installation, you can verify if it was successful by running:

supabase-mcp-server --version

If the version number is displayed, the installation was successful.

🛠️ Configuration

General Configuration Steps

1. Get Supabase Account Information

   • Log in to the Supabase Console.
   • Navigate to your project settings and find the anon_key and api_key.

2. Create an MCP Configuration File

   • Create a file named .supabase_mcp.json in the root directory of your project.
   • Add the following content:

     {
       "region": "asia-1",  // Select the correct region according to your location
       "project_ref": "your_project_ref",
       "db_url": "postgresql://localhost:5432/your_database_name"
     }
     

VSCode Configuration

1. Install the Extension

   • In VSCode, go to the Extensions Marketplace, search for, and install the Supabase MCP Server extension.

2. Configure Settings

   • Open VSCode settings (Ctrl + ,).
   • Search for supabase mcp server.
   • Fill in project_ref, anon_key, and api_key.

3. Start the Server

   • Run the following command in the Command Palette: Supabase: Start MCP Server.

IntelliJ IDEA Configuration

1. Install the Plugin

   • Open IDEA, go to File > Settings > Plugins.
   • Search for and install the Supabase MCP Server plugin.

2. Configure Settings

   • Go to File > Settings > Tools > Supabase MCP Server.
   • Fill in project_ref, anon_key, and api_key.

3. Start the Server

   • Right-click on the project directory and select Supabase: Start MCP Server.

💻 Usage Examples

Database Query Tools

Starting from version v0.3.0, the server supports SQL queries in both read-write and read-only modes.

Available Tools

• get_db_schemas: Lists all database schemas, their sizes, and the number of tables.
• get_tables: Lists all tables in a schema, their sizes, row counts, and metadata.
• get_table_schema: Gets the detailed structure of a table, including columns, keys, and relationships.
• execute_sql_query: Executes a raw SQL query with validation.

Mode Support

• Read-only Mode: Only read-only queries are allowed by default.
• Read-write Mode: Requires an explicit switch to enable all operations.
  • Switch command: supabase-mcp-server --mode=read-write

Management API Tools

Starting from version v0.3.0, it supports sending arbitrary requests through the management API, with automatic injection of project identifiers and security mode control.

Available Tools

• send_management_api_request: Sends an arbitrary request to the Supabase management API, with automatic injection of project identifiers and security mode control.
• get_api_keys: Gets the API keys of the project.

Security Mode Support

• Default Mode: Only read operations are allowed.
• Developer Mode: Enables write operations, use with caution.

🚧 Troubleshooting

Common Issues

1. Unable to connect to the database
   • Check if the db_url is correct.
   • Ensure that the database service is running.
2. Permission issues
   • Make sure the API key you are using has sufficient permissions.
3. Version incompatibility
   • Confirm that the supabase-mcp-server version matches the Supabase service version.

Contact Support

• Submit an issue to the GitHub repository.
• Join the Supabase Community Forum for help.

🚀 Future Plans

Planned Features

• Support MCP servers in more regions.
• Add support for MongoDB.
• Implement more refined security policies.

Contribution Guide

• Welcome to submit PRs and issues.
• Participate in the development of the GitHub repository.

By following the above steps, you can easily configure and use the Supabase MCP Server to improve your development efficiency.