
planetscale-best-practices-matrix
A concise feature matrix for deciding which PlanetScale safety, observability, and automation recommendations apply by engine.
- Installs
- 1.8K
- Last 24h
- +11
- Trending rank
- #8395
- Security
- Not audited
Install
Works with every agent the skills CLI supports.
npx skills add https://github.com/planetscale/skills --skill planetscale-best-practices-matrix- 01
Install
Run the command in your project. The CLI asks which agents to install for.
- 02
Describe the task
Ask your agent for something this skill covers. It loads planetscale-best-practices-matrix automatically when relevant.
- 03
Review the result
The agent follows the SKILL.md steps, scripts and references bundled with the skill.
SKILL.md
The instructions your agent reads when the skill is triggered.
Best-practices matrix
Purpose
Map database findings to recommended PlanetScale features. Use this to ensure the assessment does not miss major safety and operational surfaces.
Cross-engine recommendations
Query Insights
Recommend for every production database:
- Review slow, expensive, high-frequency, and erroring query patterns.
- For Postgres, sort Insights by CPU (
sort=cpuTimeon the Insights API) when diagnosing CPU pressure. - For sharded Vitess, review vindex usage per query pattern and the usage trend after index or routing changes.
- Correlate regressions with deploys.
- Use tags/comments to map queries back to code.
- Use tag filtering/navigation in Query Insights: the tags API
(
insights/tags,insights/tags/summaries) on both engines, plustag:key:valuefiltering and per-execution tag drill-down in the Vitess dashboard. - Use anomalies as alert and automation inputs.
Webhooks
Recommend for operational events:
- Anomalies.
- Storage pressure.
- Branch readiness/sleeping.
- Primary promotion.
- Maintenance.
- Schema recommendations where available.
- Deploy request lifecycle for Vitess.
MCP and agents
Recommend:
- Use insights-only MCP for most autonomous analysis.
- Use full MCP only with narrow scopes and read-only default.
- Put database targeting and safety rules in
AGENTS.md. - Agents generate PRs/issues/change plans; humans approve database changes.
SQLCommenter / query tags
Recommend:
- Add framework-native SQLCommenter-compatible instrumentation.
- Use low-cardinality tags.
- Include application, service, route/job, feature, source, and release SHA.
- Avoid PII and unbounded IDs.
Schema recommendation workflow
Recommend:
- Triage open recommendations.
- Correlate with code and Insights.
- Convert into migrations or branch changes.
- Test before production.
- Apply only through approved workflow.
Vitess-specific recommendations
Safe migrations
Recommend for production branches and staging branches that accept deploy requests.
Deploy requests
Recommend for schema changes into protected branches.
Force cutover discipline
Recommend documenting who may use "force cutover now" for deploy requests delayed by long-running transactions. It stops running transactions to finish schema cutover, so frequent use should trigger workload review before enabling aggressive cutover as the database default.
Admin approval
Recommend for production deploy requests in multi-admin organizations.
In a single-admin organization, approval alone is not a guard against agents: that admin can open and approve the same deploy request. Prefer a separate agent identity, or a service token that cannot approve deploy requests.
Gated deployments
Recommend when cutover timing and human control matter.
Schema revert runbook
Recommend documenting revert responsibilities and the application rollback relationship.
Branch strategy
Recommend production, staging, and short-lived development branches with safe migrations on protected targets.
Sharding/keyspace review
Recommend when query patterns or growth suggest shard-awareness problems. Do not reshard automatically.
Postgres-specific recommendations
User-defined roles
Recommend for application servers instead of default role. If roles are managed
by Terraform and passwords should stay outside Terraform state, prefer
planetscale_postgres_redacted_branch_role plus a separate password reset and
secret-manager storage path.
pg_strict
Recommend for application roles after evaluation, especially to block accidental full-table update/delete mistakes.
Traffic Control
Recommend for resource isolation of agents, exports, reports, workers, integrations, BI, and known expensive fingerprints.
Backups and PITR
Recommend verifying retention and restore drill coverage. If Terraform is the customer's source of truth, recommend managing backup policies there so backup posture changes are reviewed as infrastructure code.
PgBouncer and connection pooling
Recommend where connection churn or serverless/edge behavior creates pressure, subject to transaction-pooling limitations.
Private connectivity and IP restrictions
Recommend for customers requiring private network posture or reduced public exposure. Treat changes as production-risking.
Extensions
Recommend only when use case is clear and restart/activation impact is accepted.
Include auto_explain when automatic plan logging for slow queries would
materially improve diagnosis and the resulting log volume is acceptable.
If Terraform manages Postgres branch parameters or supported extensions, keep
that source of truth aligned with approved dashboard/API changes.
Live connections
Recommend inspecting pscale branch connections top during active connection
pressure incidents to identify sessions, blockers, and idle-in-transaction
roots without relying on normal database connection capacity.
Output
For each matrix item, mark:
- Applies: yes/no/unknown.
- Current state.
- Gap.
- Value: the specific measured finding this feature addresses (query fingerprint, anomaly count, incident, metric). State the mechanism and the measurement. Gaps are capability gaps with quantified impact, not risks safely avoided.
- Recommendation ID.
- Approval requirement.
End with:
“No changes have been applied.”
FAQ
What does the planetscale-best-practices-matrix skill do?
A concise feature matrix for deciding which PlanetScale safety, observability, and automation recommendations apply by engine.
How do I install planetscale-best-practices-matrix?
Run npx skills add https://github.com/planetscale/skills --skill planetscale-best-practices-matrix in your project. The skills CLI detects the agents you use and copies the skill into the right folder. For Claude Code you can also place the skill folder at ~/.claude/skills/planetscale-best-practices-matrix/ (personal) or .claude/skills/planetscale-best-practices-matrix/ (project).
Which AI agents can use planetscale-best-practices-matrix?
Any agent that supports the open Agent Skills format (a folder with a SKILL.md file), including Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, Windsurf, Cline, OpenCode and more.
Is planetscale-best-practices-matrix safe to install?
No partner security audit is available yet. Skills can run commands and scripts, so read the SKILL.md and any bundled files before installing.
Who maintains planetscale-best-practices-matrix?
It is published by planetscale in planetscale/skills. It has 1,847 recorded installs.
More from planetscale/skills
planetscale-mcp-agent-operating-model
planetscale/skills
Configure safe agent behavior around PlanetScale MCP, Insights, schema recommendations, and repository work without autonomous production mutation.
planetscale-postgres-safety-review
planetscale/skills
Review PlanetScale Postgres for Traffic Control, query tags, roles, pgstrict, backups/PITR, private connectivity, webhooks, branches, and safe agent operation.
planetscale-query-insights-and-tags
planetscale/skills
Use PlanetScale Insights and SQLCommenter-style query tags to attribute database load, identify risky queries, and prepare safe Traffic Control or schema recommendations.
planetscale-schema-recommendations-agent-loop
planetscale/skills
Safely triage PlanetScale schema recommendations and turn them into reviewed branches, migrations, issues, or pull requests without applying production changes.
planetscale-safe-orchestrator
planetscale/skills
Master skill that runs the full PlanetScale safe best-practices assessment — inventory, engine review, Insights, Traffic Control, webhooks, schema recommendations, codebase instrumentation, and agent operating model — then produces a unified recommendations report. Never applies changes without explicit approval. Use when the user asks to run the full assessment, all skills, or PlanetScale best-practices review.
planetscale-autonomous-execution-mode
planetscale/skills
Execute approved PlanetScale changes end-to-end without per-step approval when the operator has explicitly acknowledged the risk. Defines the risk-acknowledgment contract, scoped autonomy levels, sensible execution ordering, continuous status reporting, halt conditions, and rollback discipline. Extremely safe, very enabling.
Popular code quality & workflow skills
grill-me
mattpocock/skills
A relentless interview to sharpen a plan or design.
improve-codebase-architecture
mattpocock/skills
Scan a codebase for deepening opportunities, present them as a visual HTML report, then grill through whichever one you pick.
handoff
mattpocock/skills
Compact the current conversation into a handoff document for another agent to pick up.
domain-modeling
mattpocock/skills
Build and sharpen a project's domain model. Use when discussing codebase terminology, writing or editing a GLOSSARY.md, or recording or editing an ADR.
codebase-design
mattpocock/skills
Shared vocabulary for designing deep modules. Use when the user wants to design or improve a module's interface, find deepening opportunities, decide where a seam goes, make code more testable or AI-navigable, or when another skill needs the deep-module vocabulary.
diagnosing-bugs
mattpocock/skills
Diagnosis loop for hard bugs and performance regressions. Use when the user says "diagnose"/"debug this", or reports something broken/throwing/failing/slow.