sql-lsp: Instructions file for Claude Code

CLAUDE.md

sql-lsp CLAUDE.md is an instructions file for Claude Code from zircote/sql-lsp. It costs 468 tokens per session, scanned A, original, MIT.

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 for Claude Code

Written for Claude Code: the file is CLAUDE.md. Also seen: mentions .claude-plugin; mentions CLAUDE.md; mentions Claude Code.

This is zircote/sql-lsp's own configuration. It tells Claude Code how to work on sql-lsp itself, so it is not a mod to install elsewhere. Copy it as a starting point and replace the rules that are about this project. Everything sql-lsp configures →

Reuse

Borrowing it

Nothing to install: this file belongs to zircote/sql-lsp. Take a copy, put it at the same path in your own repository, and replace the rules that are about this project with yours.

Copy the file
curl -O https://raw.githubusercontent.com/zircote/sql-lsp/main/CLAUDE.md
Clone the repo
git clone --depth 1 https://github.com/zircote/sql-lsp

Made for: Claude Code.

Wrote this? Show the measurements

A badge with what this costs and how it scanned, read live from this page, so it follows the numbers instead of freezing them. Markdown for a README, HTML for a documentation site or a project page.

agentmods badge for sql-lsp CLAUDE.md

README.md
[![agentmods](https://agentmods.dev/badge/instructions/zircote/sql-lsp/claude-md/github.svg)](https://agentmods.dev/instructions/zircote/sql-lsp/claude-md)
Your own site
<a href="https://agentmods.dev/instructions/zircote/sql-lsp/claude-md"><img src="https://agentmods.dev/badge/instructions/zircote/sql-lsp/claude-md/github.svg" alt="Measured on agentmods" height="20"></a>

Or the 80×15 button, for a site that already has a row of RSS and ATOM ones. Only the verdict fits; the numbers stay here.

agentmods 80×15 button for sql-lsp CLAUDE.md

Your own site · 80×15
<a href="https://agentmods.dev/instructions/zircote/sql-lsp/claude-md"><img src="https://agentmods.dev/badge/instructions/zircote/sql-lsp/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>
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. A grade says what 26 rules found in the file — not that it is safe.
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.1 $0.00468 $0.00468
Opus 5.5 $0.00187 $0.00187
Sonnet 5.5 $0.00094 $0.00094
Haiku 4.5 $0.00047 $0.00047

Measured 2mo ago against content hash 47f2361f8324, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, 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 2mo 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. 2mo 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 2mo ago), licensed MIT. It adds 468 tokens to every session, about $0.0019 per session on Opus 5.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.

Related

Other instructions, from other repositories

vscode buildNext.instructions.md

Working notes and architecture documentation for the new esbuild-based build system in build/next. Use when making changes to the new build pipeline (transpile/bundle commands, NLS plugin, source-map handling, resource copying, or self-hosting watch tasks).

microsoft/vscode · 9,715 tokens

next.js AGENTS.md

AGENTS.md instructions for vercel/next.js, covering next.js development guide, codebase structure, monorepo overview, core package: packages/next and other important packages.

vercel/next.js · 7,461 tokens

vscode oss-third-party-notices.instructions.md

Instructions for microsoft/vscode, covering vs code oss third-party-notices pipeline, architecture, pipeline flow in ci, cache eligibility and rollout and applying the notice (cutover).

microsoft/vscode · 5,262 tokens

langchain AGENTS.md

AGENTS.md instructions for langchain-ai/langchain, covering global development guidelines for the langchain monorepo, corridor security analysis, project architecture and context, monorepo structure and development tools & commands.

langchain-ai/langchain · 4,680 tokens

vscode copilot-instructions.md

Copilot instructions for microsoft/vscode, covering vs code copilot instructions, project overview, root folders, core architecture (src/ folder) and built-in extensions (extensions/ folder).

microsoft/vscode · 2,750 tokens

deepseek-harness AGENTS.md

AGENTS.md instructions for deepseek-ai/deepseek-harness, covering agents.md, pre-stable apis and released session data, repository layout, commands and host sandbox failures.

deepseek-ai/deepseek-harness · 4,261 tokens