AGENTS.md · git:20260517.056e754 · 2026-05-17 · sha256 50aed032745f4edd
AGENTS.md git:20260517.056e754A
Immutable. This exact content is served forever at /api/v1/blob/50aed032745f4edd.
# AGENTS.md — mssql-performance-skills ## What this is A library of 11 Markdown skills for SQL Server performance tuning. No build system, no tests, no dependencies. The only executable is `bash scripts/verify-docs.sh`. ## Verify before commit ``` bash scripts/verify-docs.sh ``` Runs 20 documentation consistency checks. Fails block commit; warnings are advisory. A `.claude/settings.json` PostToolUse hook auto-runs this after every Write/Edit — check output after file edits. ## Critical gotchas **Dollar signs in SKILL.md break at runtime.** The Claude skill loader does shell variable expansion on SKILL.md content. Never write `$0.012` or `$[expr]` — use `USD 0.012`. verify-docs.sh check 5 catches this. **references/check-explanations.md is NOT loaded at runtime by default.** Only SKILL.md is read automatically by the skill loader. All thresholds and triggers must live in SKILL.md. The reference file is on-demand context — Claude may load it when a user asks "explain check X" or for deeper fix-option detail. **sqlplan-batch and sqlplan-index-advisor are exempt from check count matching** (verify-docs.sh check 11). Their references/check-explanations.md files don't mirror per-check entries by design. ## Adding a check → update 6 locations `skills/<skill>/SKILL.md` (check + section header + frontmatter count + Purpose count), `skills/<skill>/references/check-explanations.md` (explanation + header + Quick Reference table), `PERFORMANCE_TUNING_GUIDE.md` (Check ID Reference total), `LLM_COST_ESTIMATION.md` (total checks line). ## Adding a skill → 9 steps See `CLAUDE.md` "Adding a New Skill" section for the full checklist (files, tables, references, examples). ## Check prefix map ``` T = tsql-review I/W = sqlstats-review X = sqltrace-review V = sqlwait-review (40) S/N = sqlplan-review C = sqlplan-compare D = sqlplan-index-advisor P = sqlplan-deadlock Q = query-store-review R = procstats-review ``` sqlplan-batch has no own prefix (aggregates S/N). Available prefixes: A, B, E, F, G, H, J, K, L, M, O, U, Y, Z ## Full contributor guide `CLAUDE.md` — file map, conventions, all 11 skills listed, install instructions, development constraints, and step-by-step workflows for adding checks and skills.