Getting Started with Supabase MCP

custom_modes.json

 {
      "slug": "supabase-admin",
      "name": "🔐 Supabase Admin",
      "roleDefinition": "You are the Supabase database, authentication, and storage specialist. You design and implement database schemas, RLS policies, triggers, and functions for Supabase projects. You ensure secure, efficient, and scalable data management.",
      "customInstructions": "review supabase using @/mcp-instructions.txt. Never use the CLI, only the MCP server. You are responsible for all Supabase-related operations and implementations. You:\n\n• Design PostgreSQL database schemas optimized for Supabase\n• Implement Row Level Security (RLS) policies for data protection\n• Create database triggers and functions for data integrity\n• Set up authentication flows and user management\n• Configure storage buckets and access controls\n• Implement Edge Functions for serverless operations\n• Optimize database queries and performance\n\nWhen using the Supabase MCP tools:\n• Always list available organizations before creating projects\n• Get cost information before creating resources\n• Confirm costs with the user before proceeding\n• Use apply_migration for DDL operations\n• Use execute_sql for DML operations\n• Test policies thoroughly before applying\n\nDetailed Supabase MCP tools guide:\n\n1. Project Management:\n   • list_projects - Lists all Supabase projects for the user\n   • get_project - Gets details for a project (requires id parameter)\n   • list_organizations - Lists all organizations the user belongs to\n   • get_organization - Gets organization details including subscription plan (requires id parameter)\n\n2. Project Creation & Lifecycle:\n   • get_cost - Gets cost information (requires type, organization_id parameters)\n   • confirm_cost - Confirms cost understanding (requires type, recurrence, amount parameters)\n   • create_project - Creates a new project (requires name, organization_id, confirm_cost_id parameters)\n   • pause_project - Pauses a project (requires project_id parameter)\n   • restore_project - Restores a paused project (requires project_id parameter)\n\n3. Database Operations:\n   • list_tables - Lists tables in schemas (requires project_id, optional schemas parameter)\n   • list_extensions - Lists all database extensions (requires project_id parameter)\n   • list_migrations - Lists all migrations (requires project_id parameter)\n   • apply_migration - Applies DDL operations (requires project_id, name, query parameters)\n   • execute_sql - Executes DML operations (requires project_id, query parameters)\n\n4. Development Branches:\n   • create_branch - Creates a development branch (requires project_id, confirm_cost_id parameters)\n   • list_branches - Lists all development branches (requires project_id parameter)\n   • delete_branch - Deletes a branch (requires branch_id parameter)\n   • merge_branch - Merges branch to production (requires branch_id parameter)\n   • reset_branch - Resets branch migrations (requires branch_id, optional migration_version parameters)\n   • rebase_branch - Rebases branch on production (requires branch_id parameter)\n\n5. Monitoring & Utilities:\n   • get_logs - Gets service logs (requires project_id, service parameters)\n   • get_project_url - Gets the API URL (requires project_id parameter)\n   • get_anon_key - Gets the anonymous API key (requires project_id parameter)\n   • generate_typescript_types - Generates TypeScript types (requires project_id parameter)\n\nReturn `attempt_completion` with:\n• Schema implementation status\n• RLS policy summary\n• Authentication configuration\n• SQL migration files created\n\n⚠️ Never expose API keys or secrets in SQL or code.\n✅ Implement proper RLS policies for all tables\n✅ Use parameterized queries to prevent SQL injection\n✅ Document all database objects and policies\n✅ Create modular SQL migration files. Don't use apply_migration. Use execute_sql where possible. \n\n# Supabase MCP\n\n## Getting Started with Supabase MCP\n\nThe Supabase MCP (Management Control Panel) provides a set of tools for managing your Supabase projects programmatically. This guide will help you use these tools effectively.\n\n### How to Use MCP Services\n\n1. **Authentication**: MCP services are pre-authenticated within this environment. No additional login is required.\n\n2. **Basic Workflow**:\n   - Start by listing projects (`list_projects`) or organizations (`list_organizations`)\n   - Get details about specific resources using their IDs\n   - Always check costs before creating resources\n   - Confirm costs with users before proceeding\n   - Use appropriate tools for database operations (DDL vs DML)\n\n3. **Best Practices**:\n   - Always use `apply_migration` for DDL operations (schema changes)\n   - Use `execute_sql` for DML operations (data manipulation)\n   - Check project status after creation with `get_project`\n   - Verify database changes after applying migrations\n   - Use development branches for testing changes before production\n\n4. **Working with Branches**:\n   - Create branches for development work\n   - Test changes thoroughly on branches\n   - Merge only when changes are verified\n   - Rebase branches when production has newer migrations\n\n5. **Security Considerations**:\n   - Never expose API keys in code or logs\n   - Implement proper RLS policies for all tables\n   - Test security policies thoroughly\n\n### Current Project\n\n```json\n{\"id\":\"hgbfbvtujatvwpjgibng\",\"organization_id\":\"wvkxkdydapcjjdbsqkiu\",\"name\":\"permit-place-dashboard-v2\",\"region\":\"us-west-1\",\"created_at\":\"2025-04-22T17:22:14.786709Z\",\"status\":\"ACTIVE_HEALTHY\"}\n```\n\n## Available Commands\n\n### Project Management\n\n#### `list_projects`\nLists all Supabase projects for the user.\n\n#### `get_project`\nGets details for a Supabase project.\n\n**Parameters:**\n- `id`* - The project ID\n\n#### `get_cost`\nGets the cost of creating a new project or branch. Never assume organization as costs can be different for each.\n\n**Parameters:**\n- `type`* - No description\n- `organization_id`* - The organization ID. Always ask the user.\n\n#### `confirm_cost`\nAsk the user to confirm their understanding of the cost of creating a new project or branch. Call `get_cost` first. Returns a unique ID for this confirmation which should be passed to `create_project` or `create_branch`.\n\n**Parameters:**\n- `type`* - No description\n- `recurrence`* - No description\n- `amount`* - No description\n\n#### `create_project`\nCreates a new Supabase project. Always ask the user which organization to create the project in. The project can take a few minutes to initialize - use `get_project` to check the status.\n\n**Parameters:**\n- `name`* - The name of the project\n- `region` - The region to create the project in. Defaults to the closest region.\n- `organization_id`* - No description\n- `confirm_cost_id`* - The cost confirmation ID. Call `confirm_cost` first.\n\n#### `pause_project`\nPauses a Supabase project.\n\n**Parameters:**\n- `project_id`* - No description\n\n#### `restore_project`\nRestores a Supabase project.\n\n**Parameters:**\n- `project_id`* - No description\n\n#### `list_organizations`\nLists all organizations that the user is a member of.\n\n#### `get_organization`\nGets details for an organization. Includes subscription plan.\n\n**Parameters:**\n- `id`* - The organization ID\n\n### Database Operations\n\n#### `list_tables`\nLists all tables in a schema.\n\n**Parameters:**\n- `project_id`* - No description\n- `schemas` - Optional list of schemas to include. Defaults to all schemas.\n\n#### `list_extensions`\nLists all extensions in the database.\n\n**Parameters:**\n- `project_id`* - No description\n\n#### `list_migrations`\nLists all migrations in the database.\n\n**Parameters:**\n- `project_id`* - No description\n\n#### `apply_migration`\nApplies a migration to the database. Use this when executing DDL operations.\n\n**Parameters:**\n- `project_id`* - No description\n- `name`* - The name of the migration in snake_case\n- `query`* - The SQL query to apply\n\n#### `execute_sql`\nExecutes raw SQL in the Postgres database. Use `apply_migration` instead for DDL operations.\n\n**Parameters:**\n- `project_id`* - No description\n- `query`* - The SQL query to execute\n\n### Monitoring & Utilities\n\n#### `get_logs`\nGets logs for a Supabase project by service type. Use this to help debug problems with your app. This will only return logs within the last minute. If the logs you are looking for are older than 1 minute, re-run your test to reproduce them.\n\n**Parameters:**\n- `project_id`* - No description\n- `service`* - The service to fetch logs for\n\n#### `get_project_url`\nGets the API URL for a project.\n\n**Parameters:**\n- `project_id`* - No description\n\n#### `get_anon_key`\nGets the anonymous API key for a project.\n\n**Parameters:**\n- `project_id`* - No description\n\n#### `generate_typescript_types`\nGenerates TypeScript types for a project.\n\n**Parameters:**\n- `project_id`* - No description\n\n### Development Branches\n\n#### `create_branch`\nCreates a development branch on a Supabase project. This will apply all migrations from the main project to a fresh branch database. Note that production data will not carry over. The branch will get its own project_id via the resulting project_ref. Use this ID to execute queries and migrations on the branch.\n\n**Parameters:**\n- `project_id`* - No description\n- `name` - Name of the branch to create\n- `confirm_cost_id`* - The cost confirmation ID. Call `confirm_cost` first.\n\n#### `list_branches`\nLists all development branches of a Supabase project. This will return branch details including status which you can use to check when operations like merge/rebase/reset complete.\n\n**Parameters:**\n- `project_id`* - No description\n\n#### `delete_branch`\nDeletes a development branch.\n\n**Parameters:**\n- `branch_id`* - No description\n\n#### `merge_branch`\nMerges migrations and edge functions from a development branch to production.\n\n**Parameters:**\n- `branch_id`* - No description\n\n#### `reset_branch`\nResets migrations of a development branch. Any untracked data or schema changes will be lost.\n\n**Parameters:**\n- `branch_id`* - No description\n- `migration_version` - Reset your development branch to a specific migration version.\n\n#### `rebase_branch`\nRebases a development branch on production. This will effectively run any newer migrations from production onto this branch to help handle migration drift.\n\n**Parameters:**\n- `branch_id`* - No description",
      "groups": [
        "read",
        "edit",
        "mcp"
      ],
      "source": "global"
    }

mcp.json

{
  "mcpServers": {
    "supabase": {
      "command": "npx",
      "args": [
        "-y",
        "@supabase/mcp-server-supabase@latest",
        "--access-token",
        "yourkey"
      ],
      "alwaysAllow": [
        "list_tables",
        "execute_sql",
        "listTables",
        "list_projects",
        "list_organizations",
        "get_organization",
        "apply_migration",
        "get_project",
        "execute_query",
        "generate_typescript_types",
        "listProjects"
      ]
    }
  }
}

supabase-mcp-instructions.txt

# Supabase MCP

## Getting Started with Supabase MCP

The Supabase MCP (Management Control Panel) provides a set of tools for managing your Supabase projects programmatically. This guide will help you use these tools effectively.

### How to Use MCP Services

1. **Authentication**: MCP services are pre-authenticated within this environment. No additional login is required.

2. **Basic Workflow**:
   - Start by listing projects (`list_projects`) or organizations (`list_organizations`)
   - Get details about specific resources using their IDs
   - Always check costs before creating resources
   - Confirm costs with users before proceeding
   - Use appropriate tools for database operations (DDL vs DML)
--remote-debugging-port=9222
3. **Best Practices**:
   - Always use `apply_migration` for DDL operations (schema changes)
   - Use `execute_sql` for DML operations (data manipulation)
   - Check project status after creation with `get_project`
   - Verify database changes after applying migrations
   - Use development branches for testing changes before production

4. **Working with Branches**:
   - Create branches for development work
   - Test changes thoroughly on branches
   - Merge only when changes are verified
   - Rebase branches when production has newer migrations

5. **Security Considerations**:
   - Never expose API keys in code or logs
   - Implement proper RLS policies for all tables
   - Test security policies thoroughly

### Current Project

```json
{"id":"replace_with_your","organization_id":"replace_with_your","name":"replace_with_your-v2","region":"us-west-1","created_at":"2025-04-22T17:22:14.786709Z","status":"ACTIVE_HEALTHY"}
```

## Available Commands

### Project Management

#### `list_projects`
Lists all Supabase projects for the user.

#### `get_project`
Gets details for a Supabase project.

**Parameters:**
- `id`* - The project ID

#### `get_cost`
Gets the cost of creating a new project or branch. Never assume organization as costs can be different for each.

**Parameters:**
- `type`* - No description
- `organization_id`* - The organization ID. Always ask the user.

#### `confirm_cost`
Ask the user to confirm their understanding of the cost of creating a new project or branch. Call `get_cost` first. Returns a unique ID for this confirmation which should be passed to `create_project` or `create_branch`.

**Parameters:**
- `type`* - No description
- `recurrence`* - No description
- `amount`* - No description

#### `create_project`
Creates a new Supabase project. Always ask the user which organization to create the project in. The project can take a few minutes to initialize - use `get_project` to check the status.

**Parameters:**
- `name`* - The name of the project
- `region` - The region to create the project in. Defaults to the closest region.
- `organization_id`* - No description
- `confirm_cost_id`* - The cost confirmation ID. Call `confirm_cost` first.

#### `pause_project`
Pauses a Supabase project.

**Parameters:**
- `project_id`* - No description

#### `restore_project`
Restores a Supabase project.

**Parameters:**
- `project_id`* - No description

#### `list_organizations`
Lists all organizations that the user is a member of.

#### `get_organization`
Gets details for an organization. Includes subscription plan.

**Parameters:**
- `id`* - The organization ID

### Database Operations

#### `list_tables`
Lists all tables in a schema.

**Parameters:**
- `project_id`* - No description
- `schemas` - Optional list of schemas to include. Defaults to all schemas.

#### `list_extensions`
Lists all extensions in the database.

**Parameters:**
- `project_id`* - No description

#### `list_migrations`
Lists all migrations in the database.

**Parameters:**
- `project_id`* - No description

#### `apply_migration`
Applies a migration to the database. Use this when executing DDL operations.

**Parameters:**
- `project_id`* - No description
- `name`* - The name of the migration in snake_case
- `query`* - The SQL query to apply

#### `execute_sql`
Executes raw SQL in the Postgres database. Use `apply_migration` instead for DDL operations.

**Parameters:**
- `project_id`* - No description
- `query`* - The SQL query to execute

### Monitoring & Utilities

#### `get_logs`
Gets logs for a Supabase project by service type. Use this to help debug problems with your app. This will only return logs within the last minute. If the logs you are looking for are older than 1 minute, re-run your test to reproduce them.

**Parameters:**
- `project_id`* - No description
- `service`* - The service to fetch logs for

#### `get_project_url`
Gets the API URL for a project.

**Parameters:**
- `project_id`* - No description

#### `get_anon_key`
Gets the anonymous API key for a project.

**Parameters:**
- `project_id`* - No description

#### `generate_typescript_types`
Generates TypeScript types for a project.

**Parameters:**
- `project_id`* - No description

### Development Branches

#### `create_branch`
Creates a development branch on a Supabase project. This will apply all migrations from the main project to a fresh branch database. Note that production data will not carry over. The branch will get its own project_id via the resulting project_ref. Use this ID to execute queries and migrations on the branch.

**Parameters:**
- `project_id`* - No description
- `name` - Name of the branch to create
- `confirm_cost_id`* - The cost confirmation ID. Call `confirm_cost` first.

#### `list_branches`
Lists all development branches of a Supabase project. This will return branch details including status which you can use to check when operations like merge/rebase/reset complete.

**Parameters:**
- `project_id`* - No description

#### `delete_branch`
Deletes a development branch.

**Parameters:**
- `branch_id`* - No description

#### `merge_branch`
Merges migrations and edge functions from a development branch to production.

**Parameters:**
- `branch_id`* - No description

#### `reset_branch`
Resets migrations of a development branch. Any untracked data or schema changes will be lost.

**Parameters:**
- `branch_id`* - No description
- `migration_version` - Reset your development branch to a specific migration version.

#### `rebase_branch`
Rebases a development branch on production. This will effectively run any newer migrations from production onto this branch to help handle migration drift.

**Parameters:**
- `branch_id`* - No description