Skip to content

Commit cc9987a

Browse files
Rodriguespngregnr
andauthored
docs(client config): point client configs to Supabase documentation (#180)
* point client configs to Supabase documentation * Update README.md Co-authored-by: Greg Richardson <[email protected]> * Update README.md Co-authored-by: Greg Richardson <[email protected]> * drop Other Clients header --------- Co-authored-by: Greg Richardson <[email protected]>
1 parent f8918ec commit cc9987a

File tree

2 files changed

+10
-94
lines changed

2 files changed

+10
-94
lines changed

README.md

Lines changed: 8 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,11 @@ Before setting up the MCP server, we recommend you read our [security best pract
1515

1616
### 2. Configure your MCP client
1717

18-
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.
18+
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.
1919

20-
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.
20+
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.
2121

22-
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.
23-
24-
Most MCP clients store the configuration as JSON in the following format:
22+
Most MCP clients require the following information:
2523

2624
```json
2725
{
@@ -34,91 +32,15 @@ Most MCP clients store the configuration as JSON in the following format:
3432
}
3533
```
3634

37-
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.
38-
39-
For more information, visit the [Supabase MCP docs](https://supabase.com/docs/guides/getting-started/mcp).
40-
41-
You can also manually install it on your favorite client.
42-
43-
<details>
44-
<summary>Cursor</summary>
45-
46-
#### Click the button to install:
47-
48-
[<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)
49-
50-
#### Or install manually:
51-
52-
Go to `Cursor Settings``MCP``Add new MCP Server`. Name to your liking, use `type: http` and the following config:
53-
54-
```json
55-
{
56-
"mcpServers": {
57-
"supabase": {
58-
"type": "http",
59-
"url": "https://mcp.supabase.com/mcp"
60-
}
61-
}
62-
}
63-
```
64-
65-
For more information, see the [Cursor MCP docs](https://docs.cursor.com/context/mcp).
66-
67-
</details>
68-
69-
<details>
70-
<summary>VS Code</summary>
71-
72-
#### Click the button to install:
73-
74-
[<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)
75-
76-
#### Or install manually:
35+
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).
7736

78-
Open (or create) your `mcp.json` file and add:
79-
80-
```json
81-
{
82-
"servers": {
83-
"supabase": {
84-
"type": "http",
85-
"url": "https://mcp.supabase.com/mcp"
86-
}
87-
}
88-
}
89-
```
90-
91-
For more information, see the [VS Code MCP docs](https://code.visualstudio.com/docs/copilot/customization/mcp-servers#_add-an-mcp-server).
92-
93-
</details>
94-
95-
<details>
96-
<summary>Factory</summary>
97-
98-
#### Install via command line:
99-
100-
```bash
101-
droid mcp add supabase https://mcp.supabase.com/mcp --type http
102-
```
103-
104-
#### Or install manually:
105-
106-
Open (or create) your `~/.factory/mcp.json` file and add:
107-
108-
```json
109-
{
110-
"supabase": {
111-
"type": "http",
112-
"url": "https://mcp.supabase.com/mcp"
113-
}
114-
}
115-
```
37+
#### CLI
11638

117-
After adding the server, restart Factory or type `/mcp` within droid to complete the OAuth authentication flow.
39+
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.
11840

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

121-
</details>
43+
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.
12244

12345
## Options
12446

packages/mcp-server-supabase/src/platform/types.ts

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -234,10 +234,7 @@ export type DevelopmentOperations = {
234234

235235
export type StorageOperations = {
236236
getStorageConfig(projectId: string): Promise<StorageConfig>;
237-
updateStorageConfig(
238-
projectId: string,
239-
config: StorageConfig
240-
): Promise<void>;
237+
updateStorageConfig(projectId: string, config: StorageConfig): Promise<void>;
241238
listAllBuckets(projectId: string): Promise<StorageBucket[]>;
242239
};
243240

@@ -249,10 +246,7 @@ export type BranchingOperations = {
249246
): Promise<Branch>;
250247
deleteBranch(branchId: string): Promise<void>;
251248
mergeBranch(branchId: string): Promise<void>;
252-
resetBranch(
253-
branchId: string,
254-
options: ResetBranchOptions
255-
): Promise<void>;
249+
resetBranch(branchId: string, options: ResetBranchOptions): Promise<void>;
256250
rebaseBranch(branchId: string): Promise<void>;
257251
};
258252

0 commit comments

Comments
 (0)