planetscale-codebase-sqlcommenter-instrumentation

A repository inspection guide for adding SQLCommenter-style tags to applications connected to PlanetScale. These tags are comments attached to database queries so tools can link them to application code paths.

In plain words
What is it for?
Use it to identify the application stack, database adapter, ORM, migrations, jobs, deployment identifiers, and existing tracing before recommending query-tagging packages and conventions.
Why use it?
It helps identify the right instrumentation for a project without editing files or installing packages without approval.

Skill for Claude CodeCodex

Install

Getting it into your agent

One page per mod, every tool's command on it. A separate URL per tool would split the same page into five that compete with each other.

agentmods
npx agentmods add skills/planetscale/claude-plugin/08-codebase-sqlcommenter-instrumentation
Any agent
npx skills add planetscale/claude-plugin --skill 08-codebase-sqlcommenter-instrumentation
Clone the repo
git clone --depth 1 https://github.com/planetscale/claude-plugin

Made for: Claude Code, Codex.

Per session 33 Skills are progressive disclosure: only the name and description are preloaded; the body loads when the skill is used.
When invoked 1,055 The whole file, excluding the scripts and references it only reads on demand.
Security scan A 0 findings. Scan, not verified.
Origin 100% copy Near-identical to another mod in the catalogue.
Token cost

What it costs to keep this loaded

Counted locally with the o200k_base tokenizer, which is exact for GPT models; Claude uses its own tokenizer and its counts differ. Treat this as one consistent yardstick across the catalogue rather than a bill. Prices are per million input tokens.

ModelPer sessionOnce invoked
Fable 5 $0.00033 $0.01055
Opus 5 $0.00016 $0.00528
Sonnet 5 $0.00007 $0.00211
Haiku 4.5 $0.00003 $0.00105

Measured 2d ago against content hash 9890331329f3, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade A, and why

planetscale-codebase-sqlcommenter-instrumentation scanned grade A with 0 findings against 26 rules in 11 categories — prompt injection, anti-refusal, data exfiltration, privilege escalation, supply chain, agent snooping, system-prompt leakage, SSRF and excessive agency — measured 2d ago.

A static scan of the body, not an audit. Every finding is printed with the line that produced it so you can judge whether it matters here. A mod is markdown that instructs an agent; that is exactly why what it instructs is worth reading.

Nothing flagged

None of the 26 patterns this scan looks for appear in this file: no shell pipes, no recursive deletes, no credential paths, no hidden text, no instruction-override or anti-refusal phrasing, no agent-config snooping. That is not a guarantee, it is the absence of the things that are checkable.

Origin

This is a copy

100% identical to planetscale-codebase-sqlcommenter-instrumentation — 0 lines differ, which has more behind it and is treated as the original. This page carries a canonical link to it rather than competing with it.

planetscale-skills/08-codebase-sqlcommenter-instrumentation/SKILL.md · 191 lines

How it starts

The opening of the file, as written. The whole thing — 191 lines — stays where its author put it; the contents beside it link to each section on GitHub.

Codebase SQLCommenter instrumentation

Purpose

Inspect the application repository connected to PlanetScale and recommend the correct SQLCommenter-style instrumentation so PlanetScale Insights and Postgres Traffic Control can attribute queries to application code paths. Do not edit files or install dependencies without approval.

Repository inspection

Identify:

  • Language and framework.
  • ORM or query builder.
  • Database adapter.
  • Migration tool.
  • Background job system.
  • Routing framework.
  • Deployment metadata source, such as git SHA or release ID.
  • Existing SQL comments, query tags, tracing, OpenTelemetry, or database middleware.
  • PlanetScale connection configuration.
  • Whether the repository connects to Vitess, Postgres, or both.

Use the most native maintained option for the detected stack.

Ruby on Rails / ActiveRecord

Preferred for PlanetScale tag compatibility:

  • activerecord-sql_commenter from PlanetScale when Rails query comments need SQLCommenter format for PlanetScale Query Insights.

Other options:

  • Rails built-in query logs when sufficient and compatible with the target database/Insights behavior.
  • marginalia for older Rails or when Basecamp-style ActiveRecord query attribution is already in use.
  • sqlcommenter_rails where the project already uses the OpenTelemetry SQLCommenter ecosystem.

Recommend tags:

  • application
  • controller
  • action
  • job
  • route
  • release_sha

Laravel / PHP

Preferred:

  • spatie/laravel-sql-commenter for SQLCommenter-format comments compatible with PlanetScale Query Insights.

Recommend tags:

  • application
  • route
  • controller
  • action
  • job
  • queue
  • release_sha

Prisma / TypeScript / JavaScript

Preferred:

  • Prisma’s first-party SQL comments packages when Prisma is detected:
    • @prisma/sqlcommenter
    • @prisma/sqlcommenter-query-tags
    • @prisma/sqlcommenter-trace-context

Note: PlanetScale’s Postgres query-tag docs may list Prisma as lacking official SQLCommenter support, but Prisma’s own current docs provide first-party SQLCommenter packages. Prefer current Prisma docs when Prisma is detected.

Read the full file on GitHub · 191 lines

Changes

What this file has done since we first saw it

Hashed on every crawl. A supply-chain change to an agent config is a question of when, not whether, so the history is kept rather than the latest state alone.

  1. 2d ago First seen · 191 lines · 33 tokens per session scan A 9890331329f3

Subscribe to this mod's changes

planetscale-codebase-sqlcommenter-instrumentation is a skill published in the GitHub repository planetscale/claude-plugin (4 stars, last pushed 2d ago), licensed Apache-2.0. It adds 33 tokens to every session and 1,055 once invoked, about $0.0002 per session on Opus 5. A static security scan graded it A with 0 findings. It is 100% identical to planetscale-codebase-sqlcommenter-instrumentation, differing in 0 lines, and is treated as a copy.

Related

Other skills, from other repositories

systematic-debugging

Use when encountering any bug, test failure, or unexpected behavior, before proposing fixes.

obra/superpowers · 21 tokens

brainstorming

You MUST use this before any creative work - creating features, building components, adding functionality, or modifying behavior. Explores user intent, requirements and design before implementation.

obra/superpowers · 37 tokens

auto-perf-optimize

Run agent-driven VS Code performance or memory investigations. Use when asked to launch Code OSS, automate a VS Code scenario, run the Chat memory smoke runner, capture renderer heap snapshots, take workflow screenshots, compare run summaries, or drive a repeatable scenario before heap-snapshot analysis.

microsoft/vscode · 62 tokens

chat-perf

Run chat perf benchmarks and memory leak checks against the local dev build or any published VS Code version. Use when investigating chat rendering regressions, validating perf-sensitive changes to chat UI, or checking for memory leaks in the chat response pipeline.

microsoft/vscode · 51 tokens

chat-pet-sprite-creation

Use when creating or changing VS Code chat pet sprite art, sprite sheets, state animations, eye treatments, Stable/Insiders variants, or pet transitions under src/vs/workbench/contrib/chat/browser/widget/media/chatPet.

microsoft/vscode · 53 tokens

cpu-profile-analysis

Analyze V8/Chrome CPU profiles (.cpuprofile) and DevTools trace files (Trace-.json). Use when: profiling performance, investigating slow functions, comparing code paths, finding bottlenecks, analyzing timeToRequest, understanding call trees from sampling profiler data, analyzing layout/paint/rendering, investigating…

microsoft/vscode · 71 tokens