Skip to content

Commit d7f4ddf

Browse files
docs: update README
1 parent a88ee4a commit d7f4ddf

File tree

2 files changed

+16
-29
lines changed

2 files changed

+16
-29
lines changed

README.md

Lines changed: 15 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,19 @@
1-
# Query MCP (Supabase MCP Server)
2-
1+
# Query | MCP server for Supabase
32
<p align="center">
4-
<picture>
5-
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/user-attachments/assets/4a363bcd-7c15-47fa-a72a-d159916517f7" />
6-
<source media="(prefers-color-scheme: light)" srcset="https://github.com/user-attachments/assets/d255388e-cb1b-42ea-a7b2-0928f031e0df" />
7-
<img alt="Supabase" src="https://github.com/user-attachments/assets/d255388e-cb1b-42ea-a7b2-0928f031e0df" height="40" />
8-
</picture>
9-
&nbsp;&nbsp;
10-
<picture>
11-
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/user-attachments/assets/38db1bcd-50df-4a49-a106-1b5afd924cb2" />
12-
<source media="(prefers-color-scheme: light)" srcset="https://github.com/user-attachments/assets/82603097-07c9-42bb-9cbc-fb8f03560926" />
13-
<img alt="MCP" src="https://github.com/user-attachments/assets/82603097-07c9-42bb-9cbc-fb8f03560926" height="40" />
14-
</picture>
3+
<a href="https://thequery.dev"><img src="https://github.com/user-attachments/assets/7e9c49b5-e784-4e70-b39e-7410c22da066" alt="Control Supabase with natural language" width="800" /></a>
154
</p>
165

176
<p align="center">
18-
<strong>Enable your favorite IDE to safely execute SQL queries, manage your database end-to-end, access Management API, and handle user authentication with built-in safety controls.</strong>
7+
<strong>Query MCP is an open-source MCP server that lets your IDE safely run SQL, manage schema changes, call the Supabase Management API, and use Auth Admin SDK — all with built-in safety controls.</strong>
198
</p>
209

2110
<p align="center">
22-
<a href="https://thequery.dev"><img src="https://github.com/user-attachments/assets/420a2463-e210-4959-9f3b-b94164db23f8" alt="Control Supabase with natural language" width="800" /></a>
11+
⚡ Free & open-source forever.
12+
💎 Premium features coming soon.
13+
🧪 Early Access is live at <a href="https://thequery.dev">thequery.dev</a>.
14+
📢 Share your feedback on GitHub issues or at feedback@thequery.dev.
2315
</p>
16+
<p>
2417

2518
<p align="center">
2619
<a href="https://pypi.org/project/supabase-mcp-server/"><img src="https://img.shields.io/pypi/v/supabase-mcp-server.svg" alt="PyPI version" /></a>
@@ -35,19 +28,6 @@
3528
</p>
3629

3730

38-
## 🎉 Query MCP 🎉
39-
40-
**I'm thrilled to announce the future of this MCP server - [thequery.dev](https://thequery.dev)!**
41-
42-
While I have big plans for the future, I want to make these commitments super clear:
43-
- **The core tool will stay free forever** - free & open-source software is how I got into coding and intend to keep this MCP server this way
44-
- **Premium features will be added on top** - enhancing capabilities without limiting existing functionality
45-
- **All 300+ early adopters will get exclusive perks when paid plans land** - stay tuned!
46-
47-
**🚀 Early Access is Live!**
48-
49-
[**👉 Join Early Access at thequery.dev**](https://thequery.dev)
50-
5131
## Table of contents
5232
<p align="center">
5333
<a href="#getting-started">Getting started</a> •
@@ -128,6 +108,8 @@ You can find the full instructions on how to use Smithery.ai to connect to this
128108

129109
The Supabase MCP server requires configuration to connect to your Supabase database, access the Management API, and use the Auth Admin SDK. This section explains all available configuration options and how to set them up.
130110

111+
> 🔑 **Important**: Since v0.4 MCP server requires an API key which you can get for free at [thequery.dev](https://thequery.dev) to use this MCP server.
112+
131113
#### Environment Variables
132114

133115
The server uses the following environment variables:
@@ -139,6 +121,7 @@ The server uses the following environment variables:
139121
| `SUPABASE_REGION` | Yes* | `us-east-1` | AWS region where your Supabase project is hosted |
140122
| `SUPABASE_ACCESS_TOKEN` | No | None | Personal access token for Supabase Management API |
141123
| `SUPABASE_SERVICE_ROLE_KEY` | No | None | Service role key for Auth Admin SDK |
124+
| `QUERY_API_KEY` | Yes | None | API key from thequery.dev (required for all operations) |
142125

143126
> **Note**: The default values are configured for local Supabase development. For remote Supabase projects, you must provide your own values for `SUPABASE_PROJECT_REF` and `SUPABASE_DB_PASSWORD`.
144127
@@ -203,6 +186,7 @@ notepad "$env:APPDATA\supabase-mcp\.env"
203186
Add your configuration values to the file:
204187

205188
```
189+
QUERY_API_KEY=your-api-key
206190
SUPABASE_PROJECT_REF=your-project-ref
207191
SUPABASE_DB_PASSWORD=your-db-password
208192
SUPABASE_REGION=us-east-1
@@ -286,6 +270,7 @@ Go to Cascade -> Click on the hammer icon -> Configure -> Fill in the configurat
286270
"supabase": {
287271
"command": "/Users/username/.local/bin/supabase-mcp-server", // update path
288272
"env": {
273+
"QUERY_API_KEY": "your-api-key", // Required - get your API key at thequery.dev
289274
"SUPABASE_PROJECT_REF": "your-project-ref",
290275
"SUPABASE_DB_PASSWORD": "your-db-password",
291276
"SUPABASE_REGION": "us-east-1", // optional, defaults to us-east-1
@@ -324,6 +309,7 @@ Claude Desktop also supports MCP servers through a JSON configuration. Follow th
324309
"supabase": {
325310
"command": "/full/path/to/supabase-mcp-server", // Replace with the actual path from step 1
326311
"env": {
312+
"QUERY_API_KEY": "your-api-key", // Required - get your API key at thequery.dev
327313
"SUPABASE_PROJECT_REF": "your-project-ref",
328314
"SUPABASE_DB_PASSWORD": "your-db-password",
329315
"SUPABASE_REGION": "us-east-1", // optional, defaults to us-east-1
@@ -367,6 +353,7 @@ Cline also supports MCP servers through a similar JSON configuration. Follow the
367353
"supabase": {
368354
"command": "/full/path/to/supabase-mcp-server", // Replace with the actual path from step 1
369355
"env": {
356+
"QUERY_API_KEY": "your-api-key", // Required - get your API key at thequery.dev
370357
"SUPABASE_PROJECT_REF": "your-project-ref",
371358
"SUPABASE_DB_PASSWORD": "your-db-password",
372359
"SUPABASE_REGION": "us-east-1", // optional, defaults to us-east-1

smithery.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ startCommand:
1818
description: "(required) - Your Query API key"
1919
supabaseProjectRef:
2020
type: string
21-
description: "(required) - Supabase project reference ID"
21+
description: "(required) - Supabase project reference ID. Defaults to: 127.0.0.1:54322"
2222
supabaseDbPassword:
2323
type: string
2424
description: "(required) - Database password"

0 commit comments

Comments
 (0)