PlanetScale

{/* Generated by scripts/generate-integration-catalog.mjs. Do not edit by hand. */}

At a glance

Credentials

Set these per environment. See Connect an integration.

VariableRequiredDescription
PLANETSCALE_SERVICE_TOKENYesPlanetScale service token as the combined 'TOKEN_ID:TOKEN' value (e.g. abc123xyz:pscale_tkn_...) - the Authorization header is sent verbatim with no Bearer prefix Docs.

Setup

  1. Sign in to PlanetScale: Go to https://app.planetscale.com and sign in to your organization.
  2. Create a service token: Open your organization's Settings > Service tokens > New service token, name it, and copy both the token ID and the token secret immediately.
  3. Grant permissions: On the token's page, grant organization-level read access (e.g. read_databases) and database-level permissions (e.g. read_branch, read_deploy_request) for the databases you want to inspect.
  4. Set the environment variable: IMPORTANT: PlanetScale auth uses a composite value. Set PLANETSCALE_SERVICE_TOKEN to the token ID and token joined by a colon, e.g. PLANETSCALE_SERVICE_TOKEN=abc123xyz:pscale_tkn_.... The connector sends this verbatim as the Authorization header.
  5. Verify access: Run List Organizations, then List Databases with your organization name.

Provider notes

  • PlanetScale's Authorization header is '<TOKEN_ID>:<TOKEN>' with no Bearer prefix - the env var must contain both parts joined by a colon
  • Service token permissions are granular; missing database-level grants return 404s rather than 403s
  • List responses wrap items in a 'data' array with current_page/next_page pagination

Provider API reference.

Tools

ToolAccessDescription
List Organizations<br /><code className="reference-identifier">planetscale__list_organizations</code>ReadList organizations
List Databases<br /><code className="reference-identifier">planetscale__list_databases</code>ReadList databases
Get Database<br /><code className="reference-identifier">planetscale__get_database</code>ReadGet database
List Branches<br /><code className="reference-identifier">planetscale__list_branches</code>ReadList branches
List Deploy Requests<br /><code className="reference-identifier">planetscale__list_deploy_requests</code>ReadList deploy requests

Verify the connection

Call a read tool such as planetscale__list_organizations with arguments for your account. Confirm that the result comes from the intended account or workspace before enabling write tools.