data
PlanetScale MCP, CLI, and Lua Integration for AI Agents
PlanetScale integration docs for AI agents: MCP gateway setup, PlanetScale CLI commands, Lua API reference, credentials, and function schemas.
7 functions 6 read 1 write Bearer token auth
PlanetScale for agents
Credentials can be configured manually in web or CLI hosts.
Use this integration from Lua code mode, the headless integrations CLI, or the KosmoKrator MCP gateway. The same package metadata powers all three surfaces.
Machine-Readable Metadata
- integration_slug
planetscale- route_slug
planetscale- package
planetscale- auth_strategy
bearer_tokenBearer token- cli_setup_supported
true- cli_runtime_supported
true- mcp_gateway_supported
true- lua_supported
true- supports_multi_account
true
Quick Links
Lua APIAgent-facing namespace and function reference. PlanetScale CLIHeadless setup and direct function calls. PlanetScale MCPMCP gateway setup for external clients. Submit feedbackReport missing tools, auth problems, wrong docs, or runtime issues. ContributeAdd tools or improve metadata in the integrations repo.
PlanetScale MCP Client Matrix
Use these pages when a specific agent client or framework needs copy-pasteable MCP setup for PlanetScale.
Claude Code PlanetScale MCP setup for Claude Code. Cursor PlanetScale MCP setup for Cursor. Codex PlanetScale MCP setup for Codex. OpenAI Agents PlanetScale MCP setup for OpenAI Agents SDK. Claude Agent SDK PlanetScale MCP setup for Claude Agent SDK. Vercel AI SDK PlanetScale MCP setup for Vercel AI SDK. LangChain PlanetScale MCP setup for LangChain. LangGraph PlanetScale MCP setup for LangGraph. CrewAI PlanetScale MCP setup for CrewAI. MCP clients PlanetScale MCP setup for Generic MCP Clients.
PlanetScale CLI Matrix
Use these pages for direct PlanetScale CLI workflows in scripts, CI, cron, and agent wrappers.
CI PlanetScale CLI for CI. Cron Jobs PlanetScale CLI for cron jobs. Shell Scripts PlanetScale CLI for shell scripts. Headless Automation PlanetScale CLI for headless automation. Coding Agents PlanetScale CLI for coding agents.
Function Catalog
| Function | Type | Parameters | Description |
|---|---|---|---|
planetscale.planetscale_list_databases | Read read | 3 | List databases in a PlanetScale organization. Returns a paginated list of databases with their names, regions, and states. |
planetscale.planetscale_get_database | Read read | 2 | Get details of a specific PlanetScale database, including its state, region, and branch count. |
planetscale.planetscale_create_database | Write write | 4 | Create a new database in a PlanetScale organization. Specify the database name and optionally a region and notes. |
planetscale.planetscale_list_branches | Read read | 4 | List branches of a PlanetScale database. Returns a paginated list of branches with their names, roles, and states. |
planetscale.planetscale_get_branch | Read read | 3 | Get details of a specific branch of a PlanetScale database, including its role, region, and readiness. |
planetscale.planetscale_list_organizations | Read read | 0 | List organizations the authenticated user belongs to. Useful for discovering organization names needed by other PlanetScale tools. |
planetscale.planetscale_get_current_user | Read read | 0 | Get the profile of the currently authenticated PlanetScale user. Useful for verifying API credentials and retrieving account information. |