Selfhosted Supabase

🚀 Self-hosted Supabase MCP Server

This project enables you to set up a self-hosted Supabase MCP server, providing a flexible and customizable solution for your application needs.

🚀 Quick Start

📦 Installation

Install @supabase/supabase-js and pg using npm:

npm install @supabase/supabase-js pg

⚙️ Configure Environment Variables

Create a .env file and add the following content:

SUPABASE_URL=your-supabase-url
SUPABASE_ANON_KEY=your-supabase-anon-key
SUPABASE_SERVICE_ROLE_KEY=your-supabase-service-key (Optional)
DATABASE_URL=postgres://user:password@localhost:5432/dbname (Optional)
SUPABASE_AUTH_JWT_SECRET=your-jwt-secret (Optional)

💻 Usage Examples

Basic Usage

Run the server via Node.js:

import { createServer } from '@modelcontextprotocol/sdk'
import { SupabaseProvider } from './src/SupabaseProvider'

async function start() {
  const server = await createServer()
  server.use(new SupabaseProvider())
  await server.listen(3001)
}

start().catch(console.error)

📚 Documentation

📋 CLI Options

Usage: mcp-server [options]

Options:
  -u, --url <supabase-url>      Supabase service URL
  -a, --anon-key <anon-key>     Supabase anonymous access key
  -s, --service-key <service-key>  Supabase service role key (Optional)
  -d, --db-url <db-url>        Database connection URL (Optional)
  -j, --jwt-secret <jwt-secret>  Supabase JWT signing key (Optional)
  -c, --config <config-path>    Tool configuration file path (Default is ./mcp-tools.json)
  -h, --help                   Display help information

📄 Configuration File Examples

package.json:

{
  "scripts": {
    "start": "mcp-server --url your-supabase-url --anon-key your-anon-key"
  }
}

mcp-tools.json:

{
  "tools": {
    "supabase": {
      "version": "2.39.0",
      "path": "~/.supabase/cli"
    },
    "psql": {
      "version": "15.4",
      "path": "/usr/bin/psql"
    }
  }
}

⚙️ Custom Tool Configuration

import { defineTools } from '@modelcontextprotocol/sdk'

defineTools(() => ({
  supabase: {
    version: '2.39.0',
    path: '~/.supabase/cli'
  },
  psql: {
    version: '15.4',
    path: '/usr/bin/psql'
  }
}))

⚠️ Important Notes

⚠️ Important Note

• Supported file types: .sql, .psql, .js, .ts.
• Use # or -- to comment SQL queries.
• Ignore language-specific comments (e.g., // in TypeScript and JavaScript).

💡 Development Guide

• Language: TypeScript
• Build: Use tsc (TypeScript compiler).
• Dependencies: Refer to package.json.
• Development: Make modifications in the src/ directory.

📄 License

This project is licensed under the MIT License.