Supabase PostgreSQL

🚀 How to Set Up and Use the Supabase MCP Server

This repository provides an MCP (Machine Control Protocol) server for managing Supabase databases via Cursor and Codeium Cascade. It enables you to perform various database operations using natural - language commands.

🚀 Quick Start

✨ Features

This MCP server allows you to manage Supabase databases using natural - language commands through Cursor and Codeium Cascade, providing a convenient way for database operations.

📦 Installation

1. Clone this repository:

git clone git@github.com:Quegenx/supabase-mcp-server.git
cd supabase-mcp-server

2. Install all dependencies:

npm install

3. Build the project:

npm run build

Configuration

1. Copy your Supabase project ID and Anon public key.

2. Create an .env file:

echo "SUPABASE_PROJECT_ID=your_project_id" > .env
echo "SUPABASE_PUBLIC_KEY=your_anon_key" >> .env

3. Start the server:

npm start

Project Structure

supabase-mcp-server/
├── dist/                    # Compiled JavaScript files
│   ├── index.d.ts          # TypeScript declaration file
│   └── index.js            # Main JavaScript file
├── src/                    # Source code
│   └── index.ts           # Main TypeScript file
├── package.json           # Project configuration
├── package-lock.json      # Dependency lock file
└── tsconfig.json         # TypeScript configuration file

💻 Usage Examples

Basic Usage

Once configured, the MCP server will provide all database management tools in Cursor's Composer. Simply describe the operations you want to perform on the database, and the AI will execute them using appropriate commands.

Examples:

• 📋 "Show me all tables in the database"
• ➕ "Create a new users table with columns id, name, and email"
• 🔍 "Add an index on the email column of the users table"

Security Considerations

⚠️ Important Note

• 🔐 Keep your database connection string secure.
• ⚠️ Never commit sensitive credentials to the version control system.
• 👮 Use appropriate access controls and permissions.
• 🛡️ Validate and sanitize all inputs to prevent SQL injection.

Troubleshooting

1. Environment variable issues:

   • Ensure you have correctly set SUPABASE_PROJECT_ID and SUPABASE_PUBLIC_KEY.
   • Check if the .env file exists and has no spelling errors.

2. Connection issues:

   • Ensure your network allows outbound access to Supabase services (default port: 443).
   • Test the connection using curl https://api.supabase.com/v1/anon.

3. Startup issues:

npm start -- --env development

If you need to debug, use the following command:

DEBUG=supabase-mcp:* npm start

Platform - Specific Instructions

1. Windows users:

   • Ensure Node.js is installed.
   • Run commands in the command line.
   • Copy the .env file to the project root directory.

2. macOS and Linux users:

   • Ensure you are using the latest version of Node.js.
   • You can use xdg-open or open to open the generated log file:

xdg-open ./logs/server.log

Contributing to the Project

Welcome to fork and submit pull requests!

• Submit bug reports.
• Add new features.
• Improve the documentation.

📄 License

MIT License

Contact

Have questions or suggestions? Create an issue in GitHub Issues.