Supabase MCP

🚀 Supabase MCP Server

A Model Context Protocol (MCP) server for interacting with Supabase databases. This server provides tools to query tables and generate TypeScript types via the MCP interface.

🚀 Quick Start

The Supabase MCP Server is designed to facilitate seamless interaction with Supabase databases. It offers functionalities for querying tables and generating TypeScript types, enhancing the development experience with Supabase.

✨ Features

• Table Querying: Perform queries on any table with the following capabilities:

  • Schema selection
  • Column filtering
  • Where clauses (with multiple operators)
  • Pagination
  • Error handling

• Type Generation: Generate TypeScript types for your database:

  • Support for any schema (public, auth, API, etc.)
  • Applicable to both local and remote Supabase projects
  • Direct output to the console
  • Automatic project reference detection

📦 Installation

Prerequisites

1. Node.js (v16 or higher)
2. A Supabase project (local or hosted)
3. Supabase CLI (for type generation)

Steps

1. Clone the repository:

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

2. Install dependencies:

npm install

3. Install the Supabase CLI (for type generation):

# Using npm
npm install -g supabase

# Or using Homebrew on macOS
brew install supabase/tap/supabase

📚 Documentation

Configuration

1. Obtain your Supabase credentials:

   • For hosted projects:
     • Extract the project reference from the URL (e.g., prj-123456789abcdef0).
     • Use the associated service role key, not the anon key.
   • For local projects:
     • Ensure the local Supabase instance is running.
     • Verify that the service role key is correct.

2. Create a file named config.json and add the following content:

{
  "supabaseUrl": "your-supabase-url",
  "supabaseAnonKey": "your-supabase-anon-key"
}

Usage Examples

Querying Tables

Use the XML format for queries:

<query>
  <table>users</table>
  <columns>
    <column>id</column>
    <column>username</column>
    <column>email</column>
  </columns>
  <where>
    <condition>active = true</condition>
  </where>
</query>

Generating Types

Use the following command to generate TypeScript types:

npx supabase generate --schema public --output ./types

Troubleshooting

Type Generation Issues

1. Ensure the Supabase CLI is installed:

supabase --version

2. For local projects:

   • Ensure the local Supabase instance is running.
   • Verify that the service role key is correct.

3. For hosted projects:

   • Confirm that the project reference is correctly extracted from the URL.
   • Ensure that the service role key is used, not the anon key.

Querying Issues

1. Check the accuracy of the schema and table names.
2. Verify the column names in the selection and WHERE clauses.
3. Ensure that the service role key has the necessary permissions.

Contribution Guidelines

1. Fork the repository:

git fork https://github.com/yourusername/supabase-mcp-server.git

2. Create a feature branch:

git checkout -b feature/my-feature

3. Commit your changes:

git commit -m 'Add my feature'

4. Push to the branch:

git push origin feature/my-feature

5. Submit a pull request.

📄 License

This project is under the MIT License. For more details, see the LICENSE file.