PlanetScale llms.txt · AI Docs Browser · mdream [llms.txt Tools](https://mdream.dev/llms-txt/planetscale/llms-txt) # PlanetScale llms.txt Browse PlanetScale documentation as markdown. Click any page in the sidebar to view it, or copy the full llms.txt for your AI tools. planetscale.com/llms.txt [Raw llms.txt](https://planetscale.com/docs/llms.txt) [Raw llms-full.txt](https://planetscale.com/llms-full.txt) Copy Markdown [](https://planetscale.com/llms.txt) llms.txt Docs Agent setup prompt OpenAPI Spec PlanetScale API and OAuth applications Add a member to a team Cancel a resize request Cancel a change request Cancel a queued deploy request Check deploy request storage Close a deploy request Complete an errored deploy Complete a gated deploy request Complete a revert Create a backup Create a backup policy Create a bouncer Create a branch Create a database Create an IP restriction entry Create a deploy request Create a keyspace Create or renew an OAuth token Create an organization team Create a password Create a new query patterns report Create role credentials Create a service token Create a traffic budget Create a traffic rule Create a webhook Create a workflow Delete a backup Delete a backup policy Delete a bouncer Delete a branch Delete a database Delete an IP restriction entry Delete a keyspace Delete an OAuth token Delete an organization team Delete a password Delete a query patterns report Delete role credentials Delete a service token Delete a traffic budget Delete a traffic rule Delete a webhook Demote a branch Disable safe migrations for a branch Dismiss a schema recommendation Enable safe migrations for a branch Enable force cutover for a deploy request Get a backup Get a backup policy Get a bouncer Get a branch Retrieve a branch anomaly Get a branch change request Retrieve a branch query List queries for an error fingerprint Retrieve a query tag Get a branch schema Get current user Get a database Get an IP restriction entry Get database throttler configurations Get the default postgres role Get the deploy queue Get a deploy request Get deploy request throttler configurations Get a deployment Get an invoice Get invoice line items Get a keyspace Get keyspace rollout status Get the VSchema for the keyspace Get a maintenance schedule Get an OAuth application Get an OAuth token Get an organization Get an organization member Get an organization team Get a team member Get a password Download a finished query patterns report Show the status of a query patterns report Retrieve query statistics Retrieve a summary of query statistics Get a role Get a schema recommendation Get a service token Get a traffic budget Get a webhook Get a workflow Getting started with PlanetScale API Lint a branch schema List audit logs List backup policies List backups Get bouncer resize requests List bouncers List branch anomalies Get bouncer resize requests Get branch change requests List branch queries List branch query errors List query statistics grouped by tag List query tags List branches List available cluster sizes List IP restriction entries List database regions List databases List deploy operations List deploy request reviews List deploy requests List cluster extensions List generated query patterns reports Get invoices Get keyspaces List maintenance schedules List maintenance windows List OAuth applications List organization members List team members List teams in an organization List organizations List cluster parameters List passwords List public regions List read-only regions List regions for an organization List roles List schema recommendations List service tokens List traffic budgets List traffic budgets affecting a query fingerprint List webhooks List workflows OAuth OAuth access scopes Create or refresh OAuth token Revoke OAuth token Get OAuth token info Pagination Promote a branch Queue a deploy request Rate limits Reassign objects owned by one role to another role Remove a member from an organization Remove a member from a team Renew a password Renew role expiration Reset default credentials Reset a role's password Review a deploy request Service tokens Skip revert period Test a webhook Update auto-apply for deploy request Update auto-delete branch for deploy request Update a backup Update a backup policy Upsert a bouncer resize request Update a branch Upsert a change request for cluster size, replicas, storage, or parameters Change a branch cluster configuration Update an IP restriction entry Update database settings Update database throttler configurations Update deploy request throttler configurations Configure keyspace settings Update the VSchema for the keyspace Update an organization Update organization member role Update an organization team Update a password Update role name Update a traffic budget Update a webhook Verify workflow data Cancel a workflow Complete a workflow Cutover traffic Retry a failed workflow Reverse traffic cutover Reverse traffic Switch primary traffic Switch replica traffic Service tokens Webhook events reference Webhooks Billing PlanetScale CLI PlanetScale CLI commands: agent-guide PlanetScale CLI commands: api PlanetScale CLI commands: audit log PlanetScale CLI commands: auth PlanetScale CLI commands: backup PlanetScale CLI commands: branch PlanetScale CLI commands: completion PlanetScale CLI commands: connect PlanetScale CLI commands: connections PlanetScale CLI commands: database PlanetScale CLI commands: deploy-request PlanetScale CLI commands: import PlanetScale CLI commands: keyspace PlanetScale CLI commands: mcp PlanetScale CLI commands: org PlanetScale CLI commands: password PlanetScale CLI commands: ping PlanetScale environment set up PlanetScale CLI commands: query-patterns PlanetScale CLI commands: region PlanetScale CLI commands: role PlanetScale CLI commands: service-token Service tokens PlanetScale CLI commands: shell PlanetScale CLI commands: signup PlanetScale CLI commands: size PlanetScale CLI commands: sql PlanetScale CLI commands: traffic-control PlanetScale CLI commands: webhook PlanetScale CLI commands: workflow AI-enhanced development Cloudflare PlanetScale Model Context Protocol (MCP) Self-improving database Stripe Projects How PlanetScale uses AI PlanetScale documentation PlanetScale Metal Create a Metal database Metal PlanetScale plans Cluster sizing Deployment options PlanetScale Managed overview PlanetScale Managed on AWS overview Back up and restore in AWS Set up PlanetScale Managed in AWS AWS PrivateLink PlanetScale Managed Set up AWS VPC peering with PlanetScale Managed PlanetScale Managed on GCP overview Back up and restore in GCP Set up PlanetScale Managed in GCP Set up GCP Private Service Connect with PlanetScale Managed Maintenance schedules The proof of concept phase of an enterprise contract Cloud accounts and contents Data requests Schema snapshots User management Cluster sizes Selecting a region PlanetScale Postgres Postgres vs Vitess Back up and restore Point-in-time recovery Branching Cluster configuration Cluster storage configuration CPU Architectures Disk autoscaling Maintenance windows Cluster configuration parameters Single node Cluster updates Supported versions Connections overview PostgreSQL Proxy - Client Error Reference IP restrictions Using the Neon serverless driver PgBouncer Connect privately with AWS PrivateLink Connect privately with GCP Private Service Connect Connections quickstart Managing Roles for your Postgres database Connection resilience guide PlanetScale Postgres database dashboard Day one with PlanetScale Postgres Development Environments Extensions Extensions: pg_cron Extensions: pg_duckdb Extensions: pg_hint_plan Extensions: pg_partman_bgw Extensions: pg_squeeze Extensions: pg_stat_statements Extensions: pg_strict Extensions: pginsights Extensions: TimescaleDB Migrate from Aurora to PlanetScale Migrate from Aurora using Amazon DMS with CloudFormation Discovery Tool Migrate from Heroku to PlanetScale Import public IP addresses Migrate from Neon to PlanetScale Postgres Imports Postgres Imports - Amazon DMS Postgres Imports - PGDump and Restore Postgres Imports - pgcopydb Postgres Imports - WAL Streaming Migrate from Supabase to PlanetScale PlanetScale GitHub Actions Logical replication and Change Data Capture (CDC) Anomalies Inspect live Postgres connections Errors Cluster Logs Cluster Metrics pganalyze collector Sending Prometheus Metrics to Datadog for PlanetScale Postgres Prometheus metrics for PlanetScale Postgres Prometheus integration for PlanetScale Postgres Query Insights Tags PlanetScale Insights PlanetScale Postgres operations philosophy PlanetScale Postgres architecture Postgres compatibility PlanetScale Postgres pricing Database replicas Settings Horizontal sharding for Postgres Database Traffic Control Concepts Examples and recipes FAQ and troubleshooting Getting started Out of memory (OOM) Read-only mode PlanetScale Postgres with Bun PlanetScale Postgres with Cloudflare Workers PlanetScale Postgres with Drizzle PlanetScale Postgres with Kysely PlanetScale Postgres with Laravel PlanetScale Postgres with Node.js PlanetScale Postgres with Prisma PlanetScale Postgres quickstart PlanetScale Postgres with Ruby on Rails Web console Security and compliance Access control multi-factor authentication Organization Administrators Authentication methods Multi-factor authentication Security log Single sign-on Teams Vulnerability disclosure PlanetScale Support PlanetScale Terraform provider PlanetScale for Vitess PlanetScale Vitess architecture Organization Administrators Back up and restore PlanetScale workflow for Vitess Cluster configuration Cluster configuration parameters Connection strings Network latency Connecting to PlanetScale privately on AWS Connecting to PlanetScale privately on GCP Connecting to PlanetScale securely Deleting a database PlanetScale Connect Foreign key constraints Sending Prometheus Metrics to Datadog Grafana Dashboard for PlanetScale Branches Sending Prometheus Metrics to New Relic Handling table and column renames How to make different types of schema changes Amazon Aurora migration guide AWS RDS migration guide Azure Database for MySQL migration guide Database Import Workflow DigitalOcean database migration guide Discovery Tool GCP Cloud SQL Migration Guide Import tool Import tool Import troubleshooting MariaDB migration guide Postgres to Vitess imports Postgres to MySQL to PlanetScale migration guide Postgres to PlanetScale for Vitess migration guide Airbyte integration Cloudflare Workers database integration Datadog integration Debezium connector for PlanetScale Fivetran integration PlanetScale GitHub Actions Hightouch integration Netlify Prometheus Prometheus metrics Stitch integration PlanetScale cost management Anomalies Inspect live Vitess connections Datadog integration Errors Sending Prometheus Metrics to Datadog Grafana Dashboard for PlanetScale Branches Sending Prometheus Metrics to New Relic Query Insights Tags Schema recommendations MySQL compatibility Online DDL change unique keys Operating without foreign key constraints Pricing Database replicas Cluster configuration Cluster sizing Vitess system limits Read-only regions Database replicas VTGates What are workflows? Non-blocking schema changes Aggressive deploy request cutover Branching Data Branching® PlanetScale workflow Handling table and column renames How Online Schema Change tools work How to make different types of schema changes share a similar basic design Online DDL change unique keys Safe migrations Schema lint errors BLOB_IN_UNIQUE_KEY schema lint error DUPLICATE_ENUM_VALUE schema lint error FOREIGN_KEYS_CIRCULAR_DEPENDENCY schema lint error FOREIGN_KEYS_DISALLOWED schema lint error FOREIGN_KEYS_NONEXISTENT_TABLE schema lint error FOREIGN_KEYS_REFERENCED_VIEW schema lint error FOREIGN_KEYS_UNRESOLVED schema lint error INVALID_CHARSET schema lint error INVALID_COLUMN_REFERENCED_IN_VIEW schema lint error INVALID_ROUTING_RULES schema lint error INVALID_TABLE_REFERENCED_IN_VIEW schema lint error INVALID_VSCHEMA schema lint error NO_UNIQUE_KEY schema lint error PARTIAL_KEY_IN_UNIQUE_KEY schema lint error UNSPECIFIED schema lint error UNSUPPORTED_FEATURE schema lint error UNSUPPORTED_PARTITIONING_FEATURE schema lint error UNSUPPORTED_SHARDED_FEATURE schema lint error Throttling deploy requests Connection strings create and manage passwords Sharding with PlanetScale ALTER VSCHEMA syntax reference Avoiding cross-shard queries What is a keyspace unsharded to sharded workflow Sequence Tables Workflow: Sharded to sharded keyspace Sharding new tables Workflow: Unsharded to sharded keyspace Sharding quickstart Targeting the correct keyspace sharded VSchema Strategies for maintaining referential integrity PlanetScale terminology PlanetScale database error reference MySQL compatibility Vitess system limits Automatic Prisma migrations Automatic Rails migrations AWS Lambda connection strings Connect any application to PlanetScale Connect a Django application to PlanetScale Connect a Go application to PlanetScale Connect a Go application using GORM to PlanetScale Connect a Laravel application to PlanetScale Connect a MySQL GUI to PlanetScale Connect a Next.js application to PlanetScale Connect a Node.js application to PlanetScale Connect a PHP application to PlanetScale Connect a Rails application to PlanetScale Connect a Symfony application to PlanetScale Deploy a Django app to Heroku Deploy to Netlify Deploy to Vercel Deploy to Netlify Deploy to Vercel Next.js and PlanetScale Netlify template tutorial PlanetScale GitHub Actions Deploy to Vercel Next.js and PlanetScale Netlify template tutorial PlanetScale Vitess quickstart guide PlanetScale serverless driver for JavaScript Node.js example using the PlanetScale serverless driver PlanetScale serverless driver Prisma best practices PlanetScale serverless driver Prometheus Sending Prometheus Metrics to Datadog Grafana Dashboard for PlanetScale Branches Sending Prometheus Metrics to New Relic Prisma Vector search and storage Vector type and index reference Vector database terminology and concepts Common use cases for Vector search Vectors with an ORM Web console What is PlanetScale? OpenAPI Specs openapi Optional Blog Contact Us Status Benchmarks ## What is PlanetScale's llms.txt? PlanetScale publishes an `/llms.txt` file that provides AI systems with a structured index of its documentation. It follows the [llms.txt specification](https://llmstxt.org), organizing links to guides, API references, and tutorials under section headings so that LLMs like ChatGPT, Claude, and Gemini can quickly understand what PlanetScale offers and where to find details. Pass Spec 3 Sections 519 Links 97.7 KB Size ~24.9k Tokens Sections: Docs · OpenAPI Specs · Optional ## Add PlanetScale Docs to Your AI Assistant Select your tool to see how to add PlanetScale's llms.txt as a documentation source. Cursor Windsurf Claude Code ChatGPT Zed Copilot 1. 1 Open any chat or composer panel 2. 2 Type @Docs and select "Add new doc" 3. 3 Paste the URL: https://planetscale.com/llms.txt 4. 4 Wait for the green dot (indexing complete) 5. 5 Reference @Docs in chat when asking about PlanetScale Cursor crawls the URL and indexes all subpages. Add a trailing slash to index child pages too. ## Spec Compliance 19 notes ## Frequently Asked Questions Where is PlanetScale's llms.txt file? PlanetScale publishes its llms.txt at https://planetscale.com/llms.txt. This file provides a structured, markdown-formatted index of PlanetScale's documentation that AI systems can consume to understand the project's APIs, guides, and references. How do I use PlanetScale's llms.txt with AI coding assistants? Copy the llms.txt content and paste it into your AI assistant (Cursor, Windsurf, Claude, ChatGPT) as context. This gives the AI an accurate map of PlanetScale's documentation so it can provide better code suggestions and answers about PlanetScale. What does PlanetScale's llms.txt contain? PlanetScale's llms.txt contains 3 sections and 519 documentation links in 97.7 KB (~24.9k tokens). Key sections include Docs, OpenAPI Specs, Optional. How many tokens does PlanetScale's llms.txt use? The concise llms.txt index is approximately 24.9k tokens (97.7 KB). Most AI assistants can fit this within their context window. For the full expanded documentation, look for an llms-full.txt variant which embeds all content inline. What is PlanetScale? The database for developers. PlanetScale's llms.txt file helps AI systems understand this by providing a structured overview of its documentation, making it easier for developers to get accurate AI-assisted help when working with PlanetScale. Can I generate an llms.txt for my own project? Yes. Use the free llms.txt generator at mdream.dev/tools/llms-txt/generator to crawl your site and produce a spec-compliant llms.txt file. You can also validate existing files with the llms.txt validator. ## Browse More llms.txt Files [MongoDB The developer data platform](https://mdream.dev/llms-txt/planetscale/llms-txt/mongodb) [Neon Serverless Postgres](https://mdream.dev/llms-txt/planetscale/llms-txt/neon) [Redis The real-time data platform](https://mdream.dev/llms-txt/planetscale/llms-txt/redis) [Turso SQLite for production](https://mdream.dev/llms-txt/planetscale/llms-txt/turso) [Vercel Frontend cloud platform](https://mdream.dev/llms-txt/planetscale/llms-txt/vercel) [Prisma Next-generation Node.js and TypeScript ORM](https://mdream.dev/llms-txt/planetscale/llms-txt/prisma) [Stripe Payment processing API](https://mdream.dev/llms-txt/planetscale/llms-txt/stripe) [Drizzle TypeScript ORM that is lightweight and serverless-ready](https://mdream.dev/llms-txt/planetscale/llms-txt/drizzle) [View all 99 projects ](https://mdream.dev/llms-txt/planetscale/llms-txt) ## Related Tools [

llms.txt Generator

Generate an llms.txt for your own project.](https://mdream.dev/llms-txt/planetscale/tools/llms-txt/generator) [

llms.txt Validator

Validate your llms.txt against the official spec.](https://mdream.dev/llms-txt/planetscale/tools/llms-txt/validator) © 2026 [Harlan Wilton](https://github.com/harlan-zw) · [MIT](https://github.com/harlan-zw/mdream/blob/main/license) [GitHub](https://github.com/harlan-zw/mdream) [Discord](https://discord.com/invite/275MBUBvgP)