Be the first to get access to new connectors. Get early access →
ConnectorBay Early access

PlanetScale (BYOK) — connector documentation

  • MCP endpoint: https://byok-planetscale.connectorbay.com/mcp
  • REST API: POST https://byok-planetscale.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-planetscale.connectorbay.com/openapi.json
  • Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
  • Authentication: your own PlanetScale service token in the form ID:TOKEN (token id, a colon, then the token), sent in the X-Upstream-Key header of every request (never stored, logged or cached)
  • Health: https://byok-planetscale.connectorbay.com/health · Tool schemas: https://byok-planetscale.connectorbay.com/tools.json
  • Publisher: Unify Dynamics LLC · connectorbay.com/byok-planetscale · agent@connectorbay.com

What PlanetScale (BYOK) is for

PlanetScale (BYOK) lets an AI assistant read your own PlanetScale data through the PlanetScale API with a key you supply (service token in the form ID:TOKEN (token id, a colon, then the token)). Read-only: 7 tools (list_organizations, get_organization, list_databases, get_database, list_branches, get_branch, list_backups). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to api.planetscale.com. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by PlanetScale. PlanetScale and its logos are trademarks of their owners and are used only to say which service the connector works with.

Ask your assistant things like:

  • "Which PlanetScale organizations can I see?"
  • "What plan is my PlanetScale organization on?"
  • "What databases does my PlanetScale organization have?"
  • "Show details of my PlanetScale database"
  • "What branches does my PlanetScale database have?"
  • "Is my PlanetScale main branch ready?"

What it does

  • list_organizations: List the PlanetScale organizations the service token can see with plan, database count and dates. The answer carries paging fields (next_page).
  • get_organization: Get one PlanetScale organization: plan, database count, SSO flag, tenancy and billing-state flags.
  • list_databases: List the databases of a PlanetScale organization with kind (mysql, postgresql or neki), state, plan, region and branch counts.
  • get_database: Get one PlanetScale database: kind, state, plan, region, default branch, branch counts and feature flags.
  • list_branches: List the branches of a PlanetScale database with state, production flag, safe migrations flag, parent branch and region.
  • get_branch: Get one PlanetScale branch: state, kind, production and safe-migrations flags, shard layout flags, parent and region.
  • list_backups: List backups of one PlanetScale branch with state, size in bytes, start, completion and expiry times, and the backup policy name.

BYOK key

You bring your own PlanetScale service token in the form ID:TOKEN (token id, a colon, then the token) (https://planetscale.com/docs/api/reference/service-tokens). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to api.planetscale.com over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.

Data sources

Live from the PlanetScale API (api.planetscale.com) with a BYOK key; documentation: https://planetscale.com/docs/api/reference/getting-started-with-planetscale-api. Endpoints checked against that documentation on 2026-10-16.

What it is not

Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by PlanetScale. PlanetScale and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your PlanetScale account.

Built for: Worldwide. Languages: English.