sql-lsp CLAUDE.md

A set of project instructions for a Claude Code plugin that adds SQL development support. SQL is the language commonly used to query and change database data; the instructions cover setup, files, hooks, formatting, and linting.

In plain words
What is it for?
Use it when setting up or changing the SQL language-server integration, SQL formatting and linting, commands, or write hooks.
Why use it?
It gives the coding agent the repository-specific rules needed to modify the plugin without breaking its tools or automated checks.

Instructions file

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 instructions/zircote/sql-lsp/claude-md
Clone the repo
git clone --depth 1 https://github.com/zircote/sql-lsp
Per session 468 This file is loaded in full into every session.
When invoked 468 The same file — it is already loaded in full.
Security scan A 0 findings. Scan, not verified.
Origin original No closer match found 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.00468 $0.00468
Opus 5 $0.00234 $0.00234
Sonnet 5 $0.00094 $0.00094
Haiku 4.5 $0.00047 $0.00047

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

Security

Grade A, and why

sql-lsp CLAUDE.md 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.

CLAUDE.md · 62 lines

What it actually says

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

A Claude Code plugin providing SQL development support through sql-language-server LSP integration and sqlfluff for linting and formatting.

Setup

Run /setup to install all required tools, or manually:

npm install -g sql-language-server
pip install sqlfluff

Key Files

File Purpose
.lsp.json sql-language-server LSP configuration
hooks/hooks.json Automated development hooks
commands/setup.md /setup command definition
.claude-plugin/plugin.json Plugin metadata

Hook System

All hooks trigger afterWrite. Hooks use command -v checks to skip gracefully when optional tools aren't installed.

Hook categories:

  • Formatting (**/*.sql): sqlfluff format
  • Linting (**/*.sql): sqlfluff lint
  • Quality (**/*.sql): TODO/FIXME detection

When Modifying Hooks

Edit hooks/hooks.json. The script handles SQL files and runs appropriate tools:

  • Use || true to prevent hook failures from blocking writes
  • Use head -N to limit output verbosity
  • Use command -v tool >/dev/null && for optional tool dependencies

When Modifying LSP Config

Edit .lsp.json. The extensionToLanguage map controls which files use the LSP. Current config maps .sql files to the sql language server.

SQL-Specific Guidance

Dialect Support

sqlfluff supports multiple SQL dialects (postgres, mysql, sqlite, bigquery, etc.). Users should configure their dialect in .sqlfluff config file.

Formatting vs Linting

  • sqlfluff format - Rewrites SQL to conform to style guide
  • sqlfluff lint - Reports issues without modifying files

Conventions

  • Prefer minimal diffs
  • Keep hooks fast (use --quiet, limit output with head)
  • Documentation changes: update both README.md and commands/setup.md if relevant
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 · 62 lines · 468 tokens per session scan A 47f2361f8324

Subscribe to this mod's changes

sql-lsp CLAUDE.md is an instructions file published in the GitHub repository zircote/sql-lsp (1 stars, last pushed 23d ago), licensed MIT. It adds 468 tokens to every session, about $0.0023 per session on Opus 5. A static security scan graded it A with 0 findings. No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-31.