Skip to content

docs(client config): point client configs to Supabase documentation #180

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Rodriguespn merged 4 commits into from
Nov 20, 2025
Merged

docs(client config): point client configs to Supabase documentation #180

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d886e41
point client configs to Supabase documentation
Rodriguespn Nov 18, 2025
27e508d
Update README.md
Rodriguespn Nov 19, 2025
bff72d6
Update README.md
Rodriguespn Nov 19, 2025
141aeb0
drop Other Clients header
Rodriguespn Nov 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
94 changes: 8 additions & 86 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,11 @@ Before setting up the MCP server, we recommend you read our [security best pract

### 2. Configure your MCP client

The Supabase MCP server is hosted at `https://mcp.supabase.com/mcp` and supports the Streamable HTTP transport with Dynamic Client Registration OAuth 2.1 authentication.
To configure the Supabase MCP server on your client, visit our [setup documentation](https://supabase.com/docs/guides/getting-started/mcp#step-2-configure-your-ai-tool). You can also generate a custom MCP URL for your project by visiting the [MCP connection tab](https://supabase.com/dashboard/project/_?showConnect=true&connectTab=mcp) in the Supabase dashboard.

If you're running Supabase locally with [Supabase CLI](https://supabase.com/docs/guides/local-development/cli/getting-started), you can access the MCP server at `http://localhost:54321/mcp`. For [self-hosted Supabase](https://supabase.com/docs/guides/self-hosting/docker), check the [Enabling MCP server](https://supabase.com/docs/guides/self-hosting/enable-mcp) page. Currently, the MCP Server in CLI and self-hosted environments offer a limited subset of tools and no OAuth 2.1.
Your MCP client will automatically prompt you to log in to Supabase during setup. Be sure to choose the organization that contains the project you wish to work with.

The easiest way to connect your MCP client (such as Cursor) to your project is clicking [Connect](https://supabase.com/dashboard/project/_?showConnect=true&tab=mcp) in the Supabase dashboard and navigating to the MCP tab. There you can choose options such as [feature groups](#feature-groups), and generate one-click installers or config entries for popular clients.

Most MCP clients store the configuration as JSON in the following format:
Most MCP clients require the following information:

```json
{
Expand All @@ -34,91 +32,15 @@ Most MCP clients store the configuration as JSON in the following format:
}
```

Your MCP client will automatically prompt you to log in to Supabase during setup. This will open a browser window where you can log in to your Supabase account and grant access to the MCP client. Be sure to choose the organization that contains the project you wish to work with. In the future, we'll offer more fine grain control over these permissions.

For more information, visit the [Supabase MCP docs](https://supabase.com/docs/guides/getting-started/mcp).

You can also manually install it on your favorite client.

<details>
<summary>Cursor</summary>

#### Click the button to install:

[<img src="https://cursor.com/deeplink/mcp-install-dark.svg" alt="Install in Cursor">](https://cursor.com/en/install-mcp?name=Supabase&config=eyJ1cmwiOiJodHRwczovL21jcC5zdXBhYmFzZS5jb20vbWNwIn0%3D)

#### Or install manually:

Go to `Cursor Settings` → `MCP` → `Add new MCP Server`. Name to your liking, use `type: http` and the following config:

```json
{
"mcpServers": {
"supabase": {
"type": "http",
"url": "https://mcp.supabase.com/mcp"
}
}
}
```

For more information, see the [Cursor MCP docs](https://docs.cursor.com/context/mcp).

</details>

<details>
<summary>VS Code</summary>

#### Click the button to install:

[<img src="https://img.shields.io/badge/VS_Code-VS_Code?style=flat-square&label=Install%20Server&color=0098FF" alt="Install in VS Code">](https://vscode.dev/redirect?url=vscode:mcp/install%3F%7B%22name%22%3A%22Supabase%22%2C%22type%22%3A%22http%22%2C%22url%22%3A%22https%3A%2F%2Fmcp.supabase.com%2Fmcp%22%7D) [<img alt="Install in VS Code Insiders" src="https://img.shields.io/badge/VS_Code_Insiders-VS_Code_Insiders?style=flat-square&label=Install%20Server&color=24bfa5">](https://insiders.vscode.dev/redirect?url=vscode-insiders:mcp/install%3F%7B%22name%22%3A%22Supabase%22%2C%22type%22%3A%22http%22%2C%22url%22%3A%22https%3A%2F%2Fmcp.supabase.com%2Fmcp%22%7D)

#### Or install manually:
If you don't see your MCP client listed in our documentation, check your client's MCP documentation and copy the above MCP information into their expected format (json, yaml, etc).

Open (or create) your `mcp.json` file and add:

```json
{
"servers": {
"supabase": {
"type": "http",
"url": "https://mcp.supabase.com/mcp"
}
}
}
```

For more information, see the [VS Code MCP docs](https://code.visualstudio.com/docs/copilot/customization/mcp-servers#_add-an-mcp-server).

</details>

<details>
<summary>Factory</summary>

#### Install via command line:

```bash
droid mcp add supabase https://mcp.supabase.com/mcp --type http
```

#### Or install manually:

Open (or create) your `~/.factory/mcp.json` file and add:

```json
{
"supabase": {
"type": "http",
"url": "https://mcp.supabase.com/mcp"
}
}
```
#### CLI

After adding the server, restart Factory or type `/mcp` within droid to complete the OAuth authentication flow.
If you're running Supabase locally with [Supabase CLI](https://supabase.com/docs/guides/local-development/cli/getting-started), you can access the MCP server at `http://localhost:54321/mcp`. Currently, the MCP Server in CLI environments offers a limited subset of tools and no OAuth 2.1.

For more information, see the [Factory MCP docs](https://docs.factory.ai/cli/configuration/mcp.md).
#### Self-hosted

</details>
For [self-hosted Supabase](https://supabase.com/docs/guides/self-hosting/docker), check the [Enabling MCP server](https://supabase.com/docs/guides/self-hosting/enable-mcp) page. Currently, the MCP Server in self-hosted environments offers a limited subset of tools and no OAuth 2.1.

## Options

Expand Down
10 changes: 2 additions & 8 deletions packages/mcp-server-supabase/src/platform/types.ts
View file
Open in desktop

@Rodriguespn Rodriguespn Nov 19, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

File changed because I ran pnpm format

@Rodriguespn Rodriguespn Nov 19, 2025

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Opened this PR to add a format check CI job to prevent this

Original file line number Diff line number Diff line change
Expand Up @@ -234,10 +234,7 @@ export type DevelopmentOperations = {

export type StorageOperations = {
getStorageConfig(projectId: string): Promise<StorageConfig>;
updateStorageConfig(
projectId: string,
config: StorageConfig
): Promise<void>;
updateStorageConfig(projectId: string, config: StorageConfig): Promise<void>;
listAllBuckets(projectId: string): Promise<StorageBucket[]>;
};

Expand All @@ -249,10 +246,7 @@ export type BranchingOperations = {
): Promise<Branch>;
deleteBranch(branchId: string): Promise<void>;
mergeBranch(branchId: string): Promise<void>;
resetBranch(
branchId: string,
options: ResetBranchOptions
): Promise<void>;
resetBranch(branchId: string, options: ResetBranchOptions): Promise<void>;
rebaseBranch(branchId: string): Promise<void>;
};

Expand Down