Planetscale MCP Server

by planetscale

230 downloads

Not rated

GitHub

Database

About

The PlanetScale MCP server is a hosted MCP server that exposes your PlanetScale organizations, databases, branches, schema, and Insights data to MCP-compatible tools. It's authenticated via OAuth for configurable access to permissions and scopes, and it's accessible from any MCP

Details

Author: planetscale
Downloads: 230
Categories: Database

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

Download and install Highlight from highlightai.com/download
Navigate to the plugins tab and select "Add Custom Plugin"
Configure the plugin with the settings below

Plugin Name Planetscale MCP Server

Command (node, npx, python, etc.)

Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.
Enable "Start Automatically" if you want the plugin to start when Highlight launches

Setting up with Cursor

Open Cursor's settings
Navigate to the MCP section
Click "Add new Global MCP server"
Copy and paste the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "planetscale mcp server": {
            "planetscale": {
                "command": "pscale",
                "args": [
                    "mcp",
                    "server"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "planetscale mcp server": {
            "planetscale": {
                "command": "pscale",
                "args": [
                    "mcp",
                    "server"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "planetscale mcp server": {
            "planetscale": {
                "command": "pscale",
                "args": [
                    "mcp",
                    "server"
                ]
            }
        }
    }
}

Setting up with Claude Desktop

Open Claude Desktop's settings
Go to the Integrations tab
Click "Add MCP Server"
Use the configuration below based on your operating system

Note: Make sure Claude Desktop is running before attempting to connect.

JSON

{
    "mcpServers": {
        "planetscale mcp server": {
            "planetscale": {
                "command": "pscale",
                "args": [
                    "mcp",
                    "server"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "planetscale mcp server": {
            "planetscale": {
                "command": "pscale",
                "args": [
                    "mcp",
                    "server"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "planetscale mcp server": {
            "planetscale": {
                "command": "pscale",
                "args": [
                    "mcp",
                    "server"
                ]
            }
        }
    }
}

Setting up with Windsurf

Open Windsurf's preferences
Go to the Integrations section
Click "Add MCP Integration"
Use the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "planetscale mcp server": {
            "planetscale": {
                "command": "pscale",
                "args": [
                    "mcp",
                    "server"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "planetscale mcp server": {
            "planetscale": {
                "command": "pscale",
                "args": [
                    "mcp",
                    "server"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "planetscale mcp server": {
            "planetscale": {
                "command": "pscale",
                "args": [
                    "mcp",
                    "server"
                ]
            }
        }
    }
}

Setting up with Cline

Open Cline's settings
Navigate to the Integrations section
Click "Add MCP Server"
Copy and paste the configuration below based on your operating system

Note: Make sure to restart Cline after adding the configuration.

JSON

{
    "mcpServers": {
        "planetscale mcp server": {
            "planetscale": {
                "command": "pscale",
                "args": [
                    "mcp",
                    "server"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "planetscale mcp server": {
            "planetscale": {
                "command": "pscale",
                "args": [
                    "mcp",
                    "server"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "planetscale mcp server": {
            "planetscale": {
                "command": "pscale",
                "args": [
                    "mcp",
                    "server"
                ]
            }
        }
    }
}

Setting up with Goose

Open Goose's preferences
Go to the Integrations tab
Select "MCP Servers"
Click "Add New Server"
Use the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "planetscale mcp server": {
            "planetscale": {
                "command": "pscale",
                "args": [
                    "mcp",
                    "server"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "planetscale mcp server": {
            "planetscale": {
                "command": "pscale",
                "args": [
                    "mcp",
                    "server"
                ]
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "planetscale mcp server": {
            "planetscale": {
                "command": "pscale",
                "args": [
                    "mcp",
                    "server"
                ]
            }
        }
    }
}

From the repository

—

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "planetscale mcp server": {
            "planetscale": {
                "command": "pscale",
                "args": [
                    "mcp",
                    "server"
                ]
            }
        }
    }
}

McpServers

{
    "planetscale": {
        "command": "pscale",
        "args": [
            "mcp",
            "server"
        ]
    }
}

PlanetScale CLI

PlanetScale is more than a database and our CLI is more than a jumble of commands. The pscale command line tool brings branches, deploy requests, and other PlanetScale concepts to your fingertips.

PlanetScale CLI

Installation

macOS

pscale is available via a Homebrew Tap, and as downloadable binary from the releases page:

brew install planetscale/tap/pscale

Optional: pscale requires a MySQL 8 Client in your PATH for certain commands. You can install it by running:

brew install mysql-client@8.4

To upgrade to the latest version:

brew upgrade pscale

Linux

pscale is available as downloadable binaries from the releases page. Download the .deb or .rpm from the releases page and install with sudo dpkg -i and sudo rpm -i respectively.

Arch: pscale-cli-bin

Windows

pscale is available via scoop, and as a downloadable binary from the releases page:

scoop bucket add pscale https://github.com/planetscale/scoop-bucket.git
scoop install pscale mysql

To upgrade to the latest version:

scoop update pscale

Manually

Download the pre-compiled binaries from the releases page and copy to the desired location.

Alternatively, you can install bin which works on all macOS, Windows, and Linux platforms:

bin install https://github.com/planetscale/cli

To upgrade to the latest version

bin upgrade pscale

Container images

We provide ready to use Docker container images. To pull the latest image:

docker pull planetscale/pscale:latest

To pull a specific version:

docker pull planetscale/pscale:v0.63.0

If you like to have a shell alias that runs the latest version of pscale from docker whenever you type pscale:

mkdir -p $HOME/.config/planetscale
alias pscale="docker run -e HOME=/tmp -v $HOME/.config/planetscale:/tmp/.config/planetscale --user $(id -u):$(id -g) --rm -it -p 3306:3306/tcp planetscale/pscale:latest"

If you need a more advanced example that works with service tokens and differentiates between commands that need a pseudo terminal or non-interactive mode, have a look at this shell function.

MCP Server Integration

> Deprecated: The CLI-based MCP server (pscale mcp) is deprecated and will be removed in a future version. Use the PlanetScale MCP server instead: https://planetscale.com/docs/connect/mcp

GitHub Actions Usage

Use the setup-pscale-action to install and use pscale in GitHub Actions.

- name: Setup pscale
  uses: planetscale/setup-pscale-action@v1
- name: Use pscale
  env:
    PLANETSCALE_SERVICE_TOKEN_ID: ${{ secrets.PLANETSCALE_SERVICE_TOKEN_ID }}
    PLANETSCALE_SERVICE_TOKEN: ${{ secrets.PLANETSCALE_SERVICE_TOKEN }}
  run: |
    pscale deploy-request list my-db --org my-org

Local Development

To run a command:

go run cmd/pscale/main.go <command>

Alternatively, you can build pscale:

go build cmd/pscale/main.go

And then use the pscale binary built in cmd/pscale/ for testing:

./cmd/pscale/pscale <command>

Documentation

Please checkout our Documentation page: planetscale.com/docs

No reviews yet — be the first

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.

About

Details

Jump to

Setting up with Highlight

From the repository

Claude Desktop / Cursor

McpServers

PlanetScale CLI

Installation

macOS

Linux

Windows

Manually

Container images

MCP Server Integration

GitHub Actions Usage

Local Development

Documentation

Install

More like this

Redis

Sqlite

PostgreSQL

Npx Y convex@latest mcp start

AWS MCP Servers

whatsapp-mcp