Quegenx Supabase MCP Server

🚀 Supabase MCP Server

This Supabase MCP Server is designed to integrate with Cursor and Codeium's Composer, offering comprehensive database management capabilities.

🚀 Quick Start

📦 Installation

1. Clone this repository to your local machine:

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

2. Navigate to the project directory:

cd supabase-mcp-server

3. Install the dependencies:

npm install

4. Compile the code:

npm run build

🚀 Start the Server

After compilation, start the MCP server using the following command:

node dist/index.js [postgresql://...] 

Replace [postgresql://...] with your Supabase database connection string.

✨ Features

This MCP server supports the following operations:

• Create and delete tables
• Manage user data
• Operate on indexes
• Execute SQL queries
• Manage real-time communication channels
• User authentication

📚 Documentation

📁 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

💻 Usage Examples

⚡ Basic Usage

After the MCP server is running, you can operate the database in Cursor's Composer by describing operations in natural language. For example:

• "Show all database tables"
• "Create a new user table with id, name, and email fields"

🔧 Advanced Usage

In addition to basic CRUD operations, the server also supports complex database management tasks, such as:

• Manage real-time data streams
• Execute custom SQL queries
• Set and modify user permissions

🚀 Key Advantages

• Intuitive Control: Simplify database operation processes through natural language processing technology.
• Comprehensive Coverage: Cover multiple aspects such as tables, indexes, functions, and security.
• Seamless Integration: Use directly in Cursor and Codeium.
• Developer-Friendly: Reduce the hassle of switching between IDEs and database tools.
• Secure and Reliable: Ensure the security of database access.

⚠️ Important Note

• Protect the Connection String: Avoid exposing sensitive information.
• Permission Management: Set strict access control policies.
• Input Validation: Prevent SQL injection attacks.

🚨 Troubleshooting

1. Startup Failure

• Ensure that Node.js is correctly installed and added to the PATH environment variable.
• Check if the package.json and package-lock.json files exist.

2. Database Connection Failure

• Confirm that the database service is running and network reachable.
• Verify the format and information of the connection string.

🌟 Contribution Guidelines

Contributions from the community are welcome! If you want to submit code or suggestions, please refer to the CONTRIBUTING.md file.

📄 License

This project is licensed under the MIT License. For more information, please refer to the LICENSE file.