Skip to content

Commit cf13791

Browse files
docs: update README
1 parent a88ee4a commit cf13791

File tree

2 files changed

+16
-28
lines changed

2 files changed

+16
-28
lines changed

README.md

Lines changed: 15 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,19 @@
1-
# Query MCP (Supabase MCP Server)
1+
# Query | MCP server for Supabase
22

33
<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>
4+
<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>
155
</p>
166

177
<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>
8+
⚡ <strong>Free & open-source forever.</strong>
9+
💎 <strong>Premium features coming soon.</strong>
10+
🧪 <strong>Early Access is live at <a href="https://thequery.dev">thequery.dev</a>.</strong>
11+
📢 <strong>Share your feedback on GitHub issues or at feedback@thequery.dev. </strong>
1912
</p>
13+
<p>
2014

2115
<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>
16+
<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>
2317
</p>
2418

2519
<p align="center">
@@ -35,19 +29,6 @@
3529
</p>
3630

3731

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-
5132
## Table of contents
5233
<p align="center">
5334
<a href="#getting-started">Getting started</a> •
@@ -128,6 +109,8 @@ You can find the full instructions on how to use Smithery.ai to connect to this
128109

129110
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.
130111

112+
> 🔑 **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.
113+
131114
#### Environment Variables
132115

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

143127
> **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`.
144128
@@ -203,6 +187,7 @@ notepad "$env:APPDATA\supabase-mcp\.env"
203187
Add your configuration values to the file:
204188

205189
```
190+
QUERY_API_KEY=your-api-key
206191
SUPABASE_PROJECT_REF=your-project-ref
207192
SUPABASE_DB_PASSWORD=your-db-password
208193
SUPABASE_REGION=us-east-1
@@ -286,6 +271,7 @@ Go to Cascade -> Click on the hammer icon -> Configure -> Fill in the configurat
286271
"supabase": {
287272
"command": "/Users/username/.local/bin/supabase-mcp-server", // update path
288273
"env": {
274+
"QUERY_API_KEY": "your-api-key", // Required - get your API key at thequery.dev
289275
"SUPABASE_PROJECT_REF": "your-project-ref",
290276
"SUPABASE_DB_PASSWORD": "your-db-password",
291277
"SUPABASE_REGION": "us-east-1", // optional, defaults to us-east-1
@@ -324,6 +310,7 @@ Claude Desktop also supports MCP servers through a JSON configuration. Follow th
324310
"supabase": {
325311
"command": "/full/path/to/supabase-mcp-server", // Replace with the actual path from step 1
326312
"env": {
313+
"QUERY_API_KEY": "your-api-key", // Required - get your API key at thequery.dev
327314
"SUPABASE_PROJECT_REF": "your-project-ref",
328315
"SUPABASE_DB_PASSWORD": "your-db-password",
329316
"SUPABASE_REGION": "us-east-1", // optional, defaults to us-east-1
@@ -367,6 +354,7 @@ Cline also supports MCP servers through a similar JSON configuration. Follow the
367354
"supabase": {
368355
"command": "/full/path/to/supabase-mcp-server", // Replace with the actual path from step 1
369356
"env": {
357+
"QUERY_API_KEY": "your-api-key", // Required - get your API key at thequery.dev
370358
"SUPABASE_PROJECT_REF": "your-project-ref",
371359
"SUPABASE_DB_PASSWORD": "your-db-password",
372360
"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)