Supabase MCP Server Zdf

🚀 Supabase MCP Server

The Supabase MCP (Management Control Plane) Server is a tool for database management via Cursor's Composer and Codeium's Cascade. It offers a comprehensive set of database management features, including tables, records, indexes, functions, security, etc., and supports natural language control.

🚀 Quick Start

📦 Installation

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 file
├── package-lock.json      # Dependency lock file
└── tsconfig.json         # TypeScript configuration file

Installation Steps

1. Clone the repository:

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

2. Install dependencies:

npm install

3. Build the project:

npm run build

⚙️ Configuration

Start the Server

1. Make sure you have Node.js and npm installed.
2. Run the following command in the project root directory to start the server:

node dist/index.js [connection-string]

Example Connection String

postgresql://[email]:password@localhost:5432/dbname

Configure Environment Variables

You can store database connection information in environment variables:

export DB_USER='your-database-user'
export DB_PASSWORD='your-database-password'
export DB_HOST='localhost'
export DB_PORT=5432
export DB_NAME='your-database-name'

node dist/index.js

💻 Usage Examples

Configure the MCP Server

1. In Cursor's Composer, go to MCP settings.
2. Add a new MCP provider:
   • Name: Supabase Database
   • Type: Executable
   • Command: node dist/index.js
   • Parameters: --connection-string [email]:password@localhost:5432/dbname

Start the Server (Optional)

If you want to start the MCP server locally, run the following command:

node dist/index.js --start-server

✨ Features

Core Features

• Natural Language Control: Manage your Supabase database with simple conversational commands.
• Comprehensive Coverage: Cover all aspects of database management tools, including tables, records, indexes, functions, and security.
• Seamless Integration: Use directly in Cursor's Composer and Codeium's Cascade.

Specific Features

Table Management

• Display all tables
• Create new tables
• Delete tables
• Modify table structures

Record Management

• Insert records
• Query records
• Update records
• Delete records

Index Management

• Add indexes
• Delete indexes
• Modify indexes

Functions and Stored Procedures

• Create functions
• Delete functions
• Call functions

Security

• Manage user permissions
• Set access controls
• Audit logs

⚠️ Important Note

1. Keep your database connection string secure.
2. Avoid committing sensitive credentials to the version control system.
3. Use appropriate authentication and authorization policies.
4. Validate and sanitize all inputs effectively to prevent SQL injection.

🔧 Troubleshooting

Common Connection Issues

1. Node.js Path Issue

   • Ensure you are using the correct Node.js path.
   • On Mac/Linux: Use which node to get the correct path.
   • On Windows: Use where node to get the correct path.
   • Replace /usr/local/bin/node with your actual Node.js path.

2. File Path Issue

   • Use absolute paths instead of relative paths.
   • On Mac/Linux: Use pwd in the project directory to get the full path.
   • On Windows: Use cd to get the full path.
   • Example: /Users/username/projects/supabase-mcp-server/dist/index.js

3. MCP Does Not Detect the Tool

   • Click the refresh button in Cursor's MCP settings.
   • Make sure the server is running and there are no error messages.
   • Check if the connection string is correct.
   • Verify your Supabase credentials.

4. Port Conflict

   • Ensure the port you are using is not occupied by other applications.
   • Try using a different port.

Logging and Debugging

1. Enable detailed logging:

DEBUG=* node dist/index.js

2. Check the server output for more information.

🌟 Advanced Features

Automation Scripts

You can write automation scripts to perform complex database tasks, such as:

• Data migration
• Backup and recovery
• Performance monitoring

Extension Plugins

The community provides various extension plugins to enhance functionality, such as:

• Graphical user interface
• Integration with other services
• Custom commands

💡 Usage Tip

1. Regular Backups: Ensure regular backups of your database in case of emergencies.
2. Access Control: Strictly limit access to your database.
3. Performance Monitoring: Continuously monitor database performance and optimize in a timely manner.
4. Update Dependencies: Regularly check and update project dependencies to get the latest features and security patches.

👥 Community and Support

Forums and Discussion Groups

• Supabase Forum
• Cursor Discussion Group

Documentation and Tutorials

• Official Documentation
• Learning Tutorials

🤝 Contribution and Development

How to Contribute

1. Submit issues and suggestions:
   • Repository: GitHub Issue Tracking
2. Submit pull requests:
   • Fork the repository.
   • Submit changes.
   • Create a pull request.

Development Guide

1. Clone the repository and initialize submodules:

git clone https://github.com/Quegenx/supabase-mcp-server.git
cd supabase-mcp-server
git submodule update --init --recursive

2. Install dependencies:

npm install

3. Start the development server:

npm run dev

📄 License

The project is released under the MIT License, which allows free use, modification, and distribution.

With the Supabase MCP Server, you can manage your database more efficiently and enjoy an integrated development experience. For further information, please refer to the Official Documentation or join the community discussions.