Files
supabase/apps/docs/content/_partials/mcp_supabase_config.mdx
T

157 lines
3.4 KiB
Plaintext

<Tabs
scrollable
size="small"
type="underlined"
defaultActiveId="mac"
queryGroup="os"
>
<TabPanel id="mac" label="macOS">
```json
{
"mcpServers": {
"supabase": {
"command": "npx",
"args": [
"-y",
"@supabase/mcp-server-supabase@latest",
"--read-only",
"--project-ref=<project-ref>"
],
"env": {
"SUPABASE_ACCESS_TOKEN": "<personal-access-token>"
}
}
}
}
```
Replace `<project-ref>` with your project ref, and `<personal-access-token>` with your personal access token.
</TabPanel>
<TabPanel id="windows" label="Windows">
```json
{
"mcpServers": {
"supabase": {
"command": "cmd",
"args": [
"/c",
"npx",
"-y",
"@supabase/mcp-server-supabase@latest",
"--read-only",
"--project-ref=<project-ref>"
],
"env": {
"SUPABASE_ACCESS_TOKEN": "<personal-access-token>"
}
}
}
}
```
Or, if using `pnpm` instead of `npm`
```json
{
"mcpServers": {
"supabase": {
"command": "cmd",
"args": [
"/c",
"pnpm",
"dlx",
"@supabase/mcp-server-supabase@latest",
"--read-only",
"--project-ref=<project-ref>"
],
"env": {
"SUPABASE_ACCESS_TOKEN": "<personal-access-token>"
}
}
}
}
```
Replace `<project-ref>` with your project ref, and `<personal-access-token>` with your personal access token.
<Admonition type="note">
Make sure that `node` and `npx` are available in your system `PATH`. Assuming `node` is installed, you can get the path by running:
```shell
npm config get prefix
```
Then add it to your system `PATH` by running:
```shell
setx PATH "%PATH%;<path-to-dir>"
```
Replacing `<path-to-dir>` with the path you got from the previous command.
Finally restart {{ .app }} for the changes to take effect.
</Admonition>
</TabPanel>
<TabPanel id="wsl" label="Windows (WSL)">
```json
{
"mcpServers": {
"supabase": {
"command": "wsl",
"args": [
"npx",
"-y",
"@supabase/mcp-server-supabase@latest",
"--read-only",
"--project-ref=<project-ref>"
],
"env": {
"SUPABASE_ACCESS_TOKEN": "<personal-access-token>"
}
}
}
}
```
Replace `<project-ref>` with your project ref, and `<personal-access-token>` with your personal access token.
This assumes you have Windows Subsystem for Linux (WSL) enabled and `node`/`npx` are installed within the WSL environment.
</TabPanel>
<TabPanel id="linux" label="Linux">
```json
{
"mcpServers": {
"supabase": {
"command": "npx",
"args": [
"-y",
"@supabase/mcp-server-supabase@latest",
"--read-only",
"--project-ref=<project-ref>"
],
"env": {
"SUPABASE_ACCESS_TOKEN": "<personal-access-token>"
}
}
}
}
```
Replace `<project-ref>` with your project ref, and `<personal-access-token>` with your personal access token.
</TabPanel>
</Tabs>