About PlanetScale
This repository contains TypeScript tools maintained for the PlanetScale MCP server, shared helper code, and resources for local development and validation. It is one part of the hosted service; some tools are generated from the PlanetScale API OpenAPI specification.
Key features
- 01Maintain TypeScript MCP tools
- 02Provide shared helper code
- 03Support local development and validation
- 04Test interactively with Inspector
Use cases
- 01Develop and validate repository MCP tools
- 02Run the server locally over stdio
- 03Inspect tool behavior with MCP Inspector
MCP support
The repository provides some tools for the PlanetScale MCP server; the full hosted service also includes tools generated from the PlanetScale API OpenAPI specification. Developers can run a local stdio MCP server and test it with MCP Inspector.
Configuration
Remote servers need no local install. Pick your client, then copy the config or install in one click.
https://mcp.pscale.dev/mcp/planetscaleclaude mcp add --transport http planetscale https://mcp.pscale.dev/mcp/planetscale{"mcpServers":{"planetscale":{"type":"http","url":"https://mcp.pscale.dev/mcp/planetscale"}}}Open in Cursor{"servers":{"planetscale":{"type":"http","url":"https://mcp.pscale.dev/mcp/planetscale"}}}Open in VS Code{"mcpServers":{"planetscale":{"type":"http","url":"https://mcp.pscale.dev/mcp/planetscale"}}}{"mcpServers":{"planetscale":{"serverUrl":"https://mcp.pscale.dev/mcp/planetscale"}}}Run commands in a terminal; paste JSON into the client’s MCP config and restart. Servers that need sign-in will prompt on first connect.
Tools
Details
From the project READMEPlanetScale 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.
Related docs
- 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:
pnpm install
Build a deployment zip:
pnpm build
Push to Gram:
pnpm push
Testing locally
Run a local MCP server over stdio with inspector support:
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.
Comments
New to MCP?
From what the protocol is to installing your first server, these answers cover most first questions.
An open protocol that defines how AI applications connect to external tools and data in a uniform way. Clients talk to the model; MCP servers provide tools, resources and prompt templates. They exchange standard messages, so one server can be reused by many clients.