Windsurf Supabase

🚀 Windsurf (Windsurf) Supabase MCP Server

A Supabase MCP server optimized for seamless integration with the Windsurf editor.

This repository contains an optimized version of the Supabase MCP server for Windsurf, specifically enhanced for smooth collaboration with the Windsurf Editor. It is built on the Model Context Protocol (MCP) standard, with key improvements added to enhance error handling, response formatting, and SQL query processing.

🚀 Quick Start

✨ Features

1. Enhanced Error Handling

We faced the following challenges:

• The lack of structured error responses made debugging difficult.
• Stream parsing errors were hard to troubleshoot.
• Error messages were not friendly enough for LLMs.

Our solutions:

• Introduced structured error responses with detailed context.
• Improved error messages for better LLM comprehension.
• Added SQL query structure validation.
• Enhanced streaming error detection and recovery capabilities.

2. Improved Response Formatting

The original response format had the following limitations:

• Inconsistent JSON structures among different response types.
• Lack of metadata for UI component generation.
• Insufficient type safety.

Our improvements:

• Established a unified JSON response format standard.
• Added support for metadata for UI component generation.
• Implemented a strict TypeScript type system.
• Supported streaming of complex data structures.

3. Enhanced SQL to REST Conversion

We improved the ability to convert SQL to REST:

• Supported more complex SQL operations.
• Optimized the query validation process.
• Improved handling of JOINs and subqueries.
• Enhanced the quality of error messages for invalid SQL.

4. Authentication and Header Management

In authentication handling, we made the following improvements:

• Implemented a flexible API Key management strategy.
• Supported authentication using bearer tokens.
• Optimized header management for PostgREST requests.
• Strengthened security verification mechanisms.

📦 Installation

1. Clone this repository:

git clone https://github.com/hertzfelt/windsurf-supabase-mcp.git

2. Install dependencies:

npm install

3. Configure your Supabase connection:

SUPABASE_URL=your_supabase_url
SUPABASE_KEY=your_supabase_key

💻 Usage Examples

Basic Usage

// Example: Enhanced response handling
const response = await postgrestRequest({
  method: 'GET',
  path: '/todos?is_completed=eq.false',
});

// The response contains metadata for UI components
const { data, metadata } = response;

Advanced Usage

This server provides two main tools:

1. postgrestRequest: Enhanced PostgREST API access

const result = await postgrestRequest({
  method: 'GET',
  path: '/users',
});

2. sqlToRest: Improved SQL to REST functionality

const query = 'SELECT * FROM users WHERE age > 18';
const { method, path } = await sqlToRest({ sql: query });

📚 Documentation

This MCP server is designed to work with the Windsurf Editor, offering:

• Natural language-driven database interaction.
• Real-time query validation and automatic correction.
• Enhanced error messages for easier debugging.
• Optimized response formats to support UI component generation.

📄 License

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

🤝 Contribution Guidelines

Contributions are welcome! Please refer to our CONTRIBUTING.md file for code guidelines and the process for submitting Pull Requests.