← Back to all apps
P

PlanetScale

Codeby PlanetScale
Launched Sep 1, 2026 on ChatGPTLaunched Feb 19, 2026 on Claude

Access to your PlanetScale organizations, databases, branches, schema, and Insights data.

25ChatGPT Tools
15Claude Tools
PlanetScaleDeveloper
CodeCategory

Use Cases

code

Available Tools

Planetscale Execute Read Query

planetscale_execute_read_query
Full Description

Execute a read-only SQL query against a PlanetScale database. Write operations are rejected by the database role. This tool creates short-lived credentials and executes the query securely. Queries have a maximum execution time of 50 seconds — if a query exceeds this limit it will be cancelled, so ensure queries are optimized. For Postgres and Neki, this tool uses an ephemeral pg_read_all_data role that does not bypass row-level security (RLS); zero-row or zero-count results on RLS-protected tables may mean rows are hidden by policy, and the response may include warnings when that risk is detected. For Postgres and Neki only: optionally specify postgres_database_name when the user wants to query a non-default database.

Parameters (4 required, 2 optional)
Required
branchstring

Branch name (e.g., 'main')

databasestring

Database name

organizationstring

PlanetScale organization name

querystring

Read-only SQL query to execute

Optional
postgres_database_namestring

Postgres and Neki only: target database name to connect to. Use when the user has created additional databases in the same cluster (e.g. via CREATE DATABASE). Omit to use the default database for the branch.

use_replicaboolean

Route read queries to a read replica when the branch has replicas. Defaults to true. Set false to force the primary.

Planetscale Execute Write Query

planetscale_execute_write_query
Full Description

Execute a write SQL query (INSERT, UPDATE, DELETE, or DDL) against a PlanetScale database. This tool creates short-lived credentials and executes the query securely. Queries have a maximum execution time of 50 seconds — if a query exceeds this limit it will be cancelled, so ensure queries are optimized. TRUNCATE is blocked. DELETE and UPDATE without WHERE clause are blocked. For Postgres and Neki only: use postgres_database_name when the user has created additional databases in the same cluster and wants to run the query against a non-default database. IMPORTANT: DELETE queries and DDL statements (CREATE, DROP, ALTER, RENAME) require human confirmation - you MUST ask the user for explicit approval before setting confirm_destructive: true. Never set confirm_destructive without first showing the user the exact query and getting their explicit 'yes' or approval.

Parameters (4 required, 2 optional)
Required
branchstring

Branch name (e.g., 'main')

databasestring

Database name

organizationstring

PlanetScale organization name

querystring

SQL INSERT/UPDATE/DELETE/DDL query to execute

Optional
confirm_destructiveboolean

HUMAN CONFIRMATION REQUIRED: Only set to true after explicitly asking the user and receiving their approval. Show them the exact DELETE or DDL query first.

postgres_database_namestring

Postgres and Neki only: target database name to connect to. Use when the user has created additional databases in the same cluster (e.g. via CREATE DATABASE). Omit to use the default database for the branch.

Planetscale Get Branch

planetscale_get_branch
Full Description

Get details about a database branch

Parameters (1 required)
Required
pathParametersobject

Planetscale Get Branch Schema

planetscale_get_branch_schema
Full Description

Get the schema (tables, columns) for a database branch

Parameters (1 required, 1 optional)
Required
pathParametersobject
Optional
queryParametersobject

Planetscale Get Database

planetscale_get_database
Full Description

Get details about a specific database

Parameters (1 required)
Required
pathParametersobject

Planetscale Get Insights

planetscale_get_insights
Full Description

Get query performance insights for a PlanetScale database branch. By default, aggregates the top queries across curated metrics (slowest, most time-consuming, most rows read, most inefficient, most rows affected, and highest egress) for a comprehensive view. Can also fetch queries sorted by a single metric. Supports filtering by tablet type (primary/replica). To drill down into a specific query pattern, first call without fingerprint to discover queries (each result includes a fingerprint and keyspace), then call again with both fingerprint and keyspace from that result to get the aggregated summary stats and individual executions. Note: egress_bytes and ingress_bytes values are raw bytes; the PlanetScale UI displays these as binary megabytes (1 MB = 2^20 bytes). Durations (sum_total_duration_millis) are in milliseconds. cpuTime is available for Postgres and Neki branches only; maxEgressBytes and ingressBytes/ingressBytesPerQuery/maxIngressBytes are available for MySQL/Vitess branches only. Default time window is the last 24 hours; from/to reaches back up to 365 days, but a range wider than 25 hours must be hour-aligned -- see the from/to descriptions. The individual executions in fingerprint mode are the exception: they are always limited to the last 25 hours, so a wider fingerprint call returns a full-range summary next to executions from the last 24 hours, and the response says so.

Parameters (3 required, 10 optional)
Required
branchstring

Branch name (e.g., 'main')

databasestring

Database name

organizationstring

PlanetScale organization name

Optional
fieldsarray

Request specific metric fields from the API (e.g. ['query', 'count', 'percentTime', 'totalTime', 'cpuTime', 'p50Latency', 'rowsRead', 'rowsReadPerQuery', 'rowsAffected', 'egressBytes', 'egressBytesPerQuery', 'maxEgressBytes', 'ingressBytes', 'ingressBytesPerQuery', 'maxIngressBytes', 'indexes', 'maxShardQueries']). 'cpuTime' is Postgres/Neki-only; 'maxEgressBytes' and ingress* are MySQL/Vitess-only. Ignored when fingerprint is provided.

fingerprintstring

Query fingerprint hash to drill down into a specific query pattern. Use the `fingerprint` value from an initial insights call. Always include `keyspace` (also from the initial results) to get summary data.

fromstring

Start of time range (ISO 8601 format). Defaults to 24 hours ago. A range wider than 25 hours must start on the hour (e.g. '2026-08-19T00:00:00Z') and span at most 365 days; a wide range that is not hour-aligned is rejected, not narrowed. Supported in both discovery and fingerprint modes, though in fingerprint mode only the summary honours a wide range.

keyspacestring

Keyspace for fingerprint drill-down. Required to get summary data. Use the `keyspace` value returned in insights results (e.g. 'my_keyspace' for MySQL/Vitess or 'postgres.public' for Postgres/Neki databases).

limitnumber

Number of results per metric (default: 5, max: 20)

periodstring

Shorthand for a recent time window ending at now. Cannot be combined with from/to — use one or the other. Only supported in discovery mode (ignored in fingerprint mode — use from/to instead).

Options:15m1h3h6h12h1d2d7d8d
querystring

Filter insights by search query. Supports plain text matching and structured filters: exact match with quotes ("select count"), statement_type:select|delete|update|insert, table:table_name, keyspace:keyspace_name, table_keyspace:keyspace_name, tag:tag_key:tag_value for queries carrying that tag with that value, tag:tag_key on its own for queries carrying the tag whatever its value (including ones whose value went unrecorded), where tag_key is the bare tag name without the 'S'/'B' prefix `list_query_tags` reports and a value containing spaces or colons needs quoting (tag:route:"GET /horses"), index:index_name or index:table.index_name, indexed:true|false, multishard:true|false, query_count:>N or query_count:<N, p99:>N or p50:<N (ms), max_latency:>N (ms). Any term can be negated by an immediately preceding '!' (!tag:app:web). Ignored when fingerprint is provided.

sort_bystring

Sort order: 'all' (default) aggregates curated API calls for a comprehensive view, or specify a single metric: 'count', 'percentTime', 'totalTime', 'cpuTime', 'p50Latency', 'p99Latency', 'rowsRead', 'rowsReadPerQuery', 'rowsReadPerReturned', 'rowsAffected', 'egressBytes', 'egressBytesPerQuery', 'maxEgressBytes', 'ingressBytes', 'ingressBytesPerQuery', 'maxIngressBytes'. 'cpuTime' is Postgres/Neki-only; 'maxEgressBytes' and ingress* are MySQL/Vitess-only. Ignored when fingerprint is provided.

Options:allcountpercentTimetotalTimecpuTimep50Latencyp99LatencyrowsReadrowsReadPerQueryrowsReadPerReturnedrowsAffectedegressBytesegressBytesPerQuerymaxEgressBytesingressBytesingressBytesPerQuerymaxIngressBytes
tablet_typestring

Filter by tablet type: 'primary' or 'replica'

Options:primaryreplica
tostring

End of time range (ISO 8601 format). Defaults to now. For a range wider than 25 hours it must land on an hour boundary -- either the top of an hour or its last second ('T13:00:00Z' or 'T12:59:59Z') -- so the simplest way to ask for a wide window is to omit it, which covers everything through the current hour. Supported in both discovery and fingerprint modes.

Planetscale Get Invoice Line Items

planetscale_get_invoice_line_items
Full Description

Get all line items for an invoice. See prorated costs broken down by database branch. Including storage, egress bandwidth and development branches.

Parameters (1 required, 1 optional)
Required
pathParametersobject
Optional
queryParametersobject

Planetscale Get Organization

planetscale_get_organization
Full Description

Get details about a specific organization

Parameters (1 required)
Required
pathParametersobject

Planetscale Get Organization Billing Payment Method

planetscale_get_organization_billing_payment_method
Full Description

Get the current payment method for an organization

Parameters (1 required)
Required
pathParametersobject

Planetscale Get Payment Method Setup

planetscale_get_payment_method_setup
Full Description

Get a Stripe Checkout payment method setup started by update_payment_method. Use the setup_id returned by that tool; it is not a payment method ID. This is a one-time check and does not wait. If pending, give checkout_url to the customer and call this tool again only after they finish Checkout. If completed, this tool also returns the saved card brand, last four digits, expiration, and cardholder name as confirmation. Failed or expired setups cannot be resumed. Requires full access to the organization's payment method to inspect the setup and return the saved card.

Parameters (2 required)
Required
organizationstring

PlanetScale organization name

setup_idstring

Payment method setup ID returned by update_payment_method, not a card or payment method ID

Planetscale Get Postgres Logs

planetscale_get_postgres_logs
Full Description

Fetch server logs for a PlanetScale Postgres or Neki database branch (not available for Vitess/MySQL databases). Returns recent log entries sorted newest first. Supports filtering by log level, time range, server role, and pod name, plus an optional raw LogsQL query for advanced filtering (e.g. word matching, field filters, and pipe stages like 'error | stats count()'). Default time window is the last hour.

Parameters (3 required, 9 optional)
Required
branchstring

Branch name (e.g., 'main')

databasestring

Database name

organizationstring

PlanetScale organization name

Optional
fromstring

Start of time range (ISO 8601, e.g. '2026-08-17T00:00:00Z'). Must be used together with 'to'.

levelsarray

Filter to specific log levels: 'INFO', 'DEBUG', 'WARNING', 'ERROR'. Omit for all levels.

limitinteger

Number of log entries to return (default: 50, max: 1000)

pageinteger

Page number for pagination (default: 1)

periodstring

Recent time window ending at now, written as number+unit with no spaces (units: ms, s, m, h, d, w, y), e.g. '5m', '30m', '1h', '6h', '24h', '7d'. Cannot be combined with from/to. Defaults to '1h' when no time range is given.

podsarray

Filter to specific pod names.

querystring

Optional LogsQL filter expression matched against log content (e.g. 'checkpoint', 'error AND connection'). May include pipe stages after '|'. The tool appends its own 'sort by (_time desc)' and pagination stages after any supplied here, so a custom 'sort by' stage is overridden. Defaults to '*' (all logs).

rolestring

Filter to servers in this role: 'primary' or 'replica'. Omit for all roles.

Options:primaryreplica
tostring

End of time range (ISO 8601). Must be used together with 'from'.

Planetscale Get Query Tag

planetscale_get_query_tag
Full Description

Fetch one query tag on a PlanetScale database branch, with its values and their query counts. Pass the id from list_query_tags, prefix included -- an unprefixed or unknown id returns a not-found error. Value entries carry the same kind ('literal', 'overflow', 'collapsed') as the listing. Use this to re-read a single tag's values under different filters -- a narrower time window, a specific fingerprint or keyspace, or literal_values_only -- without listing every tag on the branch again. Data comes from PlanetScale Insights. Default time window is the last 24 hours; from/to reaches back up to 365 days, but a range wider than 25 hours must be hour-aligned -- see the from/to descriptions.

Parameters (4 required, 8 optional)
Required
branchstring

Branch name (e.g., 'main')

databasestring

Database name

organizationstring

PlanetScale organization name

tagstring

The tag id to fetch, e.g. 'Sapp' or 'Busername'. Use an `id` value from `list_query_tags`, keeping its 'S'/'B' prefix. A tag whose name contains a '.' cannot be fetched here, because the API's route splits the path on it.

Optional
fingerprintstring

Only include tags that appear on queries with this fingerprint. Get one from `get_insights`.

fromstring

Start of time range (ISO 8601 format). Defaults to 24 hours ago. A range wider than 25 hours must start on the hour (e.g. '2026-08-19T00:00:00Z') and span at most 365 days; a wide range that is not hour-aligned is rejected, not narrowed.

keyspacestring

Only include tags that appear on queries against this keyspace.

literal_values_onlyboolean

Return only real recorded values, dropping the synthetic 'Other' (overflow) and 'Collapsed' entries. Note that 'Other' is the only signal that values beyond `values_limit` exist, so dropping it leaves no indication that the value list is partial -- the response's `truncated` field counts tags, not values.

periodstring

Shorthand for a recent time window ending at now. Cannot be combined with from/to.

Options:15m1h3h6h12h1d2d7d8d
tablet_typestring

Filter by tablet type: 'primary', 'replica', or 'rdonly'.

Options:primaryreplicardonly
tostring

End of time range (ISO 8601 format). Defaults to now. For a range wider than 25 hours it must land on an hour boundary -- either the top of an hour or its last second ('T13:00:00Z' or 'T12:59:59Z') -- so the simplest way to ask for a wide window is to omit it, which covers everything through the current hour.

values_limitnumber

Maximum number of literal values returned per tag (default: 25, max: 100). Values outside that range are clamped. The 'Other' and 'Collapsed' buckets are counted separately and still returned.

Planetscale List Branches

planetscale_list_branches
Full Description

List all branches within a databases

Parameters (1 required, 1 optional)
Required
pathParametersobject
Optional
queryParametersobject

Planetscale List Cluster Sizes

planetscale_list_cluster_sizes
Full Description

List available PlanetScale cluster sizes (SKUs) for an organization and database engine, including Neki-specific PS-*_NEKI sizes. PS-* sizes use autoscaling network-backed storage; M-* sizes use super fast NVMe storage drives. The rate field is for an HA cluster with 2 replicas; replica_rate is for a single instance. Single instance databases are only available for Postgres. Metal instances must be HA.

Parameters (1 required, 2 optional)
Required
organizationstring

PlanetScale organization name

Optional
enginestring

Database engine to list SKUs for (default: mysql)

Options:mysqlpostgresqlneki
typestring

Filter to only autoscaling (PS-*, network-backed) or metal (M-*, local storage) sizes

Options:autoscalingmetal

Planetscale List Databases

planetscale_list_databases
Full Description

List all databases within an organization

Parameters (1 required, 1 optional)
Required
pathParametersobject
Optional
queryParametersobject

Planetscale List Invoices

planetscale_list_invoices
Full Description

List all invoices for an organization.

Parameters (1 required, 1 optional)
Required
pathParametersobject
Optional
queryParametersobject

Planetscale List Organizations

planetscale_list_organizations
Full Description

List all PlanetScale organizations you have access to

Parameters (0 required, 1 optional)
Optional
queryParametersobject

Planetscale List Query Error Executions

planetscale_list_query_error_executions
Full Description

List the individual captured query executions that failed with a given error fingerprint on a PlanetScale database branch. Each execution includes the normalized SQL, tables, keyspace, user, row counts, duration, error message, and query tags. Get an error_fingerprint from list_query_error_patterns first. This endpoint cannot filter by tablet type, so executions from all tablet types are returned even when the fingerprint came from a tablet-filtered pattern list. Data comes from PlanetScale Insights. Default time window is the last 24 hours. These results describe individual query executions, so unlike get_insights and the query tag tools the window is capped at 25 hours: a wider from/to falls back to the default window server-side.

Parameters (4 required, 4 optional)
Required
branchstring

Branch name (e.g., 'main')

databasestring

Database name

error_fingerprintstring

Error fingerprint identifying the error to list executions for. Use the `error_fingerprint` value from `list_query_error_patterns`.

organizationstring

PlanetScale organization name

Optional
fromstring

Start of time range (ISO 8601 format). Defaults to 24 hours ago. These endpoints report individual query executions and do not serve the wide windows `get_insights` and the query tag tools do: a range longer than 25 hours falls back to the default window instead of being rejected, which makes recent data look like a wide-window answer.

limitnumber

Maximum number of results to return (default: 25, max: 100). These endpoints do not paginate, so when a response reports truncated: true, raise this limit or narrow the time window to see the rest.

periodstring

Shorthand for a recent time window ending at now. Cannot be combined with from/to.

Options:15m1h3h6h12h1d2d7d8d
tostring

End of time range (ISO 8601 format). Defaults to now.

Planetscale List Query Error Patterns

planetscale_list_query_error_patterns
Full Description

List failing queries for a PlanetScale database branch, aggregated by error fingerprint. Each pattern reports the error message, how many times it occurred, when it was last seen, and total/average duration. Use list_query_error_executions with an error_fingerprint from these results to see the individual failed executions behind a pattern. Data comes from PlanetScale Insights. Default time window is the last 24 hours. These results describe individual query executions, so unlike get_insights and the query tag tools the window is capped at 25 hours: a wider from/to falls back to the default window server-side.

Parameters (3 required, 7 optional)
Required
branchstring

Branch name (e.g., 'main')

databasestring

Database name

organizationstring

PlanetScale organization name

Optional
fromstring

Start of time range (ISO 8601 format). Defaults to 24 hours ago. These endpoints report individual query executions and do not serve the wide windows `get_insights` and the query tag tools do: a range longer than 25 hours falls back to the default window instead of being rejected, which makes recent data look like a wide-window answer.

limitnumber

Maximum number of results to return (default: 25, max: 100). These endpoints do not paginate, so when a response reports truncated: true, raise this limit or narrow the time window to see the rest.

periodstring

Shorthand for a recent time window ending at now. Cannot be combined with from/to.

Options:15m1h3h6h12h1d2d7d8d
querystring

Search error patterns by error message text.

sort_bystring

Sort error patterns by: 'count' (default, most frequent), 'lastRun' (most recent), 'error' (message), 'totalTime', or 'timePerQuery'.

Options:errorlastRuncounttotalTimetimePerQuery
tablet_typestring

Filter by tablet type: 'primary', 'replica', or 'rdonly'.

Options:primaryreplicardonly
tostring

End of time range (ISO 8601 format). Defaults to now.

Planetscale List Query Tag Summaries

planetscale_list_query_tag_summaries
Full Description

Break query statistics on a PlanetScale database branch down by query tag value -- total time, latency, rows read, and errors per application, route, job, or user. This is the tool that answers 'which part of my app is causing this load', as opposed to get_insights, which answers 'which query'. Pass one or more tag id values from list_query_tags in tags; several ids group by the combination of their values. Each row's dimensions maps the grouped tag ids to that row's values. Rows are sorted descending by sort_by (default 'totalTime'). A curated set of metrics is requested by default; fields widens or narrows it, and the response echoes the effective set as a map from each requested name to the key it is serialized under, since the two differ (count arrives as query_count). Metrics outside that set are stripped, so a 0 on a returned metric is a real measurement rather than an unrequested field. The sort_by metric is always included, whether or not it was asked for. dimension_counts reports how many matched queries had the grouping tag's value collapsed (collapsed_count) out of the total (total_count) -- those queries carry the tag, but their value was never recorded and cannot be recovered. Data comes from PlanetScale Insights. Default time window is the last 24 hours; from/to reaches back up to 365 days, but a range wider than 25 hours must be hour-aligned -- see the from/to descriptions.

Parameters (4 required, 9 optional)
Required
branchstring

Branch name (e.g., 'main')

databasestring

Database name

organizationstring

PlanetScale organization name

tagsarray

Tag ids to group by, taken from the `id` values returned by `list_query_tags` with their prefix intact, e.g. ['Sapp'] or ['Sapp', 'Broute']. Several ids group by the combination of their values. An id missing its 'S'/'B' prefix is rejected.

Optional
fieldsarray

Metric fields to return. Defaults to a curated set (dimensions, count, errorCount, totalTime, percentTime, p50Latency, p99Latency, rowsRead, rowsReadPerReturned, rowsAffected, egressBytes, lastRun), because omitting this server-side returns all 43 metrics and most of them will be zero-fill for any one question. 'dimensions' is always included, since without it the rows cannot be told apart. The response echoes the effective set as `fields`, mapping each requested name to the key it is serialized under (`count` arrives as `query_count`); metrics outside that set are stripped, so a 0 on a returned metric is a real measurement.

fromstring

Start of time range (ISO 8601 format). Defaults to 24 hours ago. A range wider than 25 hours must start on the hour (e.g. '2026-08-19T00:00:00Z') and span at most 365 days; a wide range that is not hour-aligned is rejected, not narrowed.

limitnumber

Maximum number of summary rows to return (default: 25, max: 100). This endpoint does not paginate, so when a response reports truncated: true, raise this limit or narrow the time window, tags, or query.

periodstring

Shorthand for a recent time window ending at now. Cannot be combined with from/to.

Options:15m1h3h6h12h1d2d7d8d
querystring

Filter the query statistics being summarized. This is a structured search, not a plain substring: supported terms include `fingerprint:<hash>`, `keyspace:<name>`, `tag:<key>:<value>` (or `tag:<key>` for any value), `user:<name>`, `statement_type:<type>`, `table:<name>`, `index:<name>`, and comparisons like `p99:>100`, while a bare word matches the normalized SQL. Prefix a term with '!' to negate it. This is also the only way to restrict these summaries to one fingerprint or keyspace -- unlike `list_query_tags`, this endpoint has no separate fingerprint or keyspace filter.

sort_bystring

Metric to sort rows by, descending. Defaults to 'totalTime'. Accepts any name listed under `fields`.

Options:dimensionslastRuncounterrorCountrowsReadrowsAffectedrowsReturnedrowsReadPerReturnedrowsReadPerQueryrowsReturnedPerQueryrowsAffectedPerQuerytotalTimecpuTimeioTimepercentTimepercentCpuTimepercentIoTimesumShardQueriesmaxShardQueriesavgShardQueriesavgParallelWorkerstablequalifiedTabletableKeyspaceindexesroutingIndexesp50Latencyp99LatencymaxLatencyegressBytesegressBytesPerQuerymaxEgressBytesingressBytesingressBytesPerQuerymaxIngressBytesblocksReadblocksHitblockCacheHitRatioblocksDirtiedblocksWrittentrafficControlWarningstrafficControlThrottledtrafficControlChecked
statement_typestring

Only summarize queries of this statement type.

Options:SELECTINSERTUPDATEDELETE
tablet_typestring

Filter by tablet type: 'primary', 'replica', or 'rdonly'.

Options:primaryreplicardonly
tostring

End of time range (ISO 8601 format). Defaults to now. For a range wider than 25 hours it must land on an hour boundary -- either the top of an hour or its last second ('T13:00:00Z' or 'T12:59:59Z') -- so the simplest way to ask for a wide window is to omit it, which covers everything through the current hour.

Planetscale List Query Tags

planetscale_list_query_tags
Full Description

List the query tags seen on a PlanetScale database branch's queries, with their values and query counts. Query tags are SQLCommenter-style annotations an application attaches in SQL comments (e.g. 'app', 'controller', 'route'), plus dimensions Insights derives from the connection itself (e.g. 'username', 'application_name'). Start here: the id values this returns are the only way to reach get_query_tag and list_query_tag_summaries, which is where query load actually gets attributed to a tag value. Each id keeps a one-character origin prefix -- 'S' for a tag the application submitted in a SQL comment (source: 'sql'), 'B' for one Insights captured itself (source: 'system') -- and name is the same id with the prefix stripped. Each value entry carries a kind: 'literal' is a real recorded value; 'overflow' is the synthetic 'Other' bucket aggregating values ranked beyond values_limit; 'collapsed' is the synthetic 'Collapsed' bucket counting queries where Insights had stopped recording this tag's values because it saw too many distinct ones, so those values are unrecoverable rather than zero. Data comes from PlanetScale Insights. Default time window is the last 24 hours; from/to reaches back up to 365 days, but a range wider than 25 hours must be hour-aligned -- see the from/to descriptions.

Parameters (3 required, 9 optional)
Required
branchstring

Branch name (e.g., 'main')

databasestring

Database name

organizationstring

PlanetScale organization name

Optional
fingerprintstring

Only include tags that appear on queries with this fingerprint. Get one from `get_insights`.

fromstring

Start of time range (ISO 8601 format). Defaults to 24 hours ago. A range wider than 25 hours must start on the hour (e.g. '2026-08-19T00:00:00Z') and span at most 365 days; a wide range that is not hour-aligned is rejected, not narrowed.

keyspacestring

Only include tags that appear on queries against this keyspace.

literal_values_onlyboolean

Return only real recorded values, dropping the synthetic 'Other' (overflow) and 'Collapsed' entries. Note that 'Other' is the only signal that values beyond `values_limit` exist, so dropping it leaves no indication that the value list is partial -- the response's `truncated` field counts tags, not values.

name_patternstring

Filter tags by a SQL LIKE pattern matched against the prefixed id. Wildcards are not added for you, so a bare word like 'app' matches nothing: use '%app%' to find 'Sapp', where '%' matches any run of characters and '_' matches exactly one (so '_app' matches both 'Sapp' and 'Bapp').

periodstring

Shorthand for a recent time window ending at now. Cannot be combined with from/to.

Options:15m1h3h6h12h1d2d7d8d
tablet_typestring

Filter by tablet type: 'primary', 'replica', or 'rdonly'.

Options:primaryreplicardonly
tostring

End of time range (ISO 8601 format). Defaults to now. For a range wider than 25 hours it must land on an hour boundary -- either the top of an hour or its last second ('T13:00:00Z' or 'T12:59:59Z') -- so the simplest way to ask for a wide window is to omit it, which covers everything through the current hour.

values_limitnumber

Maximum number of literal values returned per tag (default: 25, max: 100). Values outside that range are clamped. The 'Other' and 'Collapsed' buckets are counted separately and still returned.

Planetscale List Regions For Organization

planetscale_list_regions_for_organization
Full Description

List the regions available for an organization.

Parameters (1 required, 1 optional)
Required
pathParametersobject
Optional
queryParametersobject

Planetscale List Schema Recommendations

planetscale_list_schema_recommendations
Full Description

List all schema recommendations for a database. Each schema recommendation is based on production data from the users database. If you have access to the code base generating the queries, evaluate the code in the context of the recommendation to determine the best steps forward for the specific application. Use schema recommendations as a data point for improvement, not a directive.

Suggestions include adding indexes, removing redundant indexes, preventing primary key exhaustion, unused tables and other general performance improvements. See https://planetscale.com/docs/postgres/monitoring/schema-recommendations for a full list as well as warnings of possible risks when making schema changes.

Set state to "open" to retrieve only open recommendations.

Parameters (1 required, 1 optional)
Required
pathParametersobject
Optional
queryParametersobject

Planetscale Search Documentation

planetscale_search_documentation
Full Description

Search across PlanetScale documentation and blog posts to find relevant information, code examples, API references, and guides. Use this tool when you need to answer questions about PlanetScale, find specific documentation, understand how features work, or locate implementation details. The search returns contextual content with titles and direct links to documentation pages and /blog posts.

Parameters (1 required)
Required
querystring

Search query for PlanetScale docs and blog posts

Planetscale Update Payment Method

planetscale_update_payment_method
Full Description

Start a secure Stripe Checkout session to add or replace an organization's billing card. Use when a customer asks to add, set, replace, or update their PlanetScale payment method. This tool never collects card details: return checkout_url to the customer and let them complete Stripe Checkout in their browser. It returns a setup_id; do not call this tool again while that setup is pending. After the customer finishes, call get_payment_method_setup with the same organization and setup_id. Requires full access to the organization's payment method.

Parameters (1 required)
Required
organizationstring

PlanetScale organization name