PlanetScale CLI commands: mcp

Getting Started

Make sure to first set up your PlanetScale developer environment. Once you’ve installed the pscale CLI, you can interact with PlanetScale and manage your databases straight from the command line.

The `mcp` command

Manage PlanetScale model context protocol (MCP) configuration. PlanetScale recommends the hosted MCP server:

https://mcp.pscale.dev/mcp/planetscale

See PlanetScale MCP server for full setup instructions across editors and agents. Usage:

pscale mcp <SUB-COMMAND> <FLAG>

Available sub-commands

Sub-command	Product	Description
`install`	Postgres, Vitess	Install or print hosted MCP setup for a target editor
`server`	Postgres, Vitess	Start the legacy local stdio MCP server (deprecated — prefer hosted MCP)

The `install` sub-command

Usage:

pscale mcp install --target <TARGET> --format json

Flag	Description
`--target`	Required. Supported values: `cursor`, `claude-code`, `zed`
`-f`, `--format json`	JSON response with `status`, `message`, `next_steps`, and setup details

Cursor — writes hosted MCP config to ~/.cursor/mcp.json when possible. Claude Code and Zed — return action_required JSON with the command or docs URL to run (OAuth on first MCP use).

Available flags

Flag	Description
`--target`	Target for MCP installation. Supported values: `cursor`, `claude-code`, `zed`.
`-h`, `--help`	View help for `mcp` command

Global flags

Command	Description
`--api-token <TOKEN>`	The API token to use for authenticating against the PlanetScale API.
`--api-url <URL>`	The base URL for the PlanetScale API. Default is `https://api.planetscale.com/`.
`--config <CONFIG_FILE>`	Config file. Default is `$HOME/.config/planetscale/pscale.yml`.
`--debug`	Enable debug mode.
`-f`, `--format <FORMAT>`	Show output in a specific format. Possible values: `human` (default), `json`, `csv`.
`--no-color`	Disable color output.
`--service-token <TOKEN>`	The service token for authenticating.
`--service-token-id <TOKEN_ID>`	The service token ID for authenticating.

Examples

Install hosted MCP for Cursor

Command:

pscale mcp install --target cursor --format json

Output (JSON):

{
  "status": "ok",
  "target": "cursor",
  "hosted_mcp_url": "https://mcp.pscale.dev/mcp/planetscale",
  "message": "Hosted MCP server configured for cursor"
}

Claude Code setup instructions

Command:

pscale mcp install --target claude-code --format json

Returns action_required JSON with the claude mcp add command in next_steps.

Need help?

Get help from the PlanetScale Support team, or join our Discord community to see how others are using PlanetScale.

Introduction

Using the pscale CLI

CLI command reference

PlanetScale CLI commands: mcp

Getting Started

The `mcp` command

Available sub-commands

The `install` sub-command

Available flags

Global flags

Examples

Install hosted MCP for Cursor

Claude Code setup instructions

Need help?

​Getting Started

​The mcp command

​Available sub-commands

​The install sub-command

​Available flags

​Global flags

​Examples

​Install hosted MCP for Cursor

​Claude Code setup instructions

​Need help?

Getting Started

The `mcp` command

Available sub-commands

The `install` sub-command

Available flags

Global flags

Examples

Install hosted MCP for Cursor

Claude Code setup instructions

Need help?