io.github.planetscale/mcp-server

Official

by planetscale · TypeScript

PlanetScale

Connect to PlanetScale databases, branches, schema, query insights, and execute SQL

Connect to PlanetScale databases, query schema, insights, and execute SQL.

Topics

mcp-server

README.md1 KBView on GitHub

PlanetScale MCP Server Tools

This repository contains tool implementations that are part of the PlanetScale MCP server.

The full hosted MCP server includes additional tools that are generated from the PlanetScale API OpenAPI spec, not every production tool lives in this repository.

Hosted server overview: PlanetScale MCP docs
PlanetScale API OpenAPI spec: OpenAPI spec docs

Project scope

This repo is focused on:

MCP tools we maintain directly in TypeScript
shared helper code used by those tools
local development and validation of the open-source portions

Some MCP functionality is intentionally not duplicated here because it is generated from the API spec and maintained in that generation pipeline.

Quick start

Install dependencies:

bash

pnpm install

Build a deployment zip:

bash

pnpm build

Push to Gram:

bash

pnpm push

Testing locally

Run a local MCP server over stdio with inspector support:

bash

pnpm dev

This launches MCP Inspector so you can interactively test tool behavior during development.

Contributing

See CONTRIBUTING.md for contribution workflow and project conventions.

Install

claude_desktop_config.json

{
  "mcpServers": {
    "mcp-server": {
      "command": "npx",
      "args": [
        "-y",
        "mcp-remote",
        "https://mcp.pscale.dev/mcp/planetscale"
      ]
    }
  }
}

Desktop config is stdio-only; this bridges via mcp-remote. Native remote: Settings > Connectors.

Topics

PlanetScale MCP Server Tools

Related docs

Project scope

Quick start

Testing locally

Contributing

Install