What is deepsql CLAUDE.md?

A project instruction document for DeepSQLAI's database-performance assistant, covering its Java backend and React frontend. A monorepo is one repository containing multiple related parts of a project.

Use it when developing or troubleshooting DeepSQLAI, including its Spring Boot backend, React/Vite frontend, database integrations, tests, and local run commands.

It gives coding agents a shared overview of the architecture, technology choices, supported databases, and development commands, reducing guesswork when changing the project.

How DeepSQLAI/deepsql configures Claude Code

Reuse

Borrowing it

Nothing to install: this file belongs to DeepSQLAI/deepsql. 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/DeepSQLAI/deepsql/main/CLAUDE.md

Clone the repo

git clone --depth 1 https://github.com/DeepSQLAI/deepsql

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.

README.md

[![agentmods](https://agentmods.dev/badge/instructions/deepsqlai/deepsql/claude-md/github.svg)](https://agentmods.dev/instructions/deepsqlai/deepsql/claude-md)

Your own site

<a href="https://agentmods.dev/instructions/deepsqlai/deepsql/claude-md"><img src="https://agentmods.dev/badge/instructions/deepsqlai/deepsql/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.

Your own site · 80×15

<a href="https://agentmods.dev/instructions/deepsqlai/deepsql/claude-md"><img src="https://agentmods.dev/badge/instructions/deepsqlai/deepsql/claude-md.svg" alt="Reviewed on agentmods" width="80" height="20"></a>

Per session 22,669 This file is loaded in full into every session.

When invoked 22,669 The same file — it is already loaded in full.

Security scan B 2 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.

Model	Per session	Once invoked
Fable 5.1	$0.22669	$0.22669
Opus 5.5	$0.09068	$0.09068
Sonnet 5.5	$0.04534	$0.04534
Haiku 4.5	$0.02267	$0.02267

Measured 1mo ago against content hash 809c0f6be16a, method: parsed. Prices are Anthropic first-party input rates as of 2026-10-07, from the pricing page.

Security

Grade B, and why

deepsql CLAUDE.md scanned grade B with 2 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 1mo 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.

Asks for rootmediumPrivilege escalation

A mod that escalates privileges can change anything on the machine, not only the project.

`sudo -u postgres psql`, which only exists on a bare-metal install — on the Compose

Makes network callslowCapability

Not a fault in itself. Listed so you know the mod talks to something, and to what.

curl -X POST http://localhost:8080/api/users/admin/bootstrap \

CLAUDE.md · 1,207 lines

How it starts

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

CLAUDE.md — DBA Agent

Full reference: See docs/root/CLAUDE.md for comprehensive architecture, all API endpoints, entity details, and integration flows. Architecture summary: See AGENTS.md for high-level codebase map used by all AI agents.

Project Overview

DBA Agent is an AI-powered Database Performance Assistant with autonomous troubleshooting capabilities. Monorepo with a Java backend and a React frontend.

Tech Stack:

Backend: Spring Boot 4.0.3 (Java 25), Spring AI 2.0.0-M2, PostgreSQL vault DB
Frontend: React 19.2.3, Vite 7.3.0, Tailwind CSS 4.1.18
AI: bring-your-own LLM via LlmProviderRegistry — OpenAI, Azure OpenAI, or any OpenAI-compatible server. Vector store: pgvector or Azure AI Search (RAG)
Caching: Redis/Valkey
Databases supported: PostgreSQL, MySQL (via provider registry pattern)

Development Commands

Backend (Spring Boot)

cd backend
mvn clean install                    # Build
mvn spring-boot:run                  # Run (dev mode, auth disabled)
mvn spring-boot:run -Dspring-boot.run.profiles=prod  # Run (prod, auth enabled)
mvn test                             # Run all tests
mvn test -Dtest="*IntegrationTest"   # Integration tests only

Backend URL: http://localhost:8080/api

Frontend (React + Vite)

npm install       # Install dependencies
npm run dev       # Dev server (http://localhost:3000)
npm run lint      # Lint
npm run test:local-regression  # Quick local regression suite
npm run local-deploy           # Start services + run local regression suite
npm run mcp:phase1  # Start the Phase 1 DeepSQL MCP server (stdio)
npm run build     # Build (dev)
npm run build:production  # Build (prod)

Dev credentials: There is no baked-in admin/admin login — AuthController.login requires a real User row matched by email, not username, so a fresh database (new Postgres volume) has no account to log in with at all. SECURITY_AUTH_ENABLED=false only bypasses JWT/MCP token validation (JwtAuthenticationFilter, McpTokenAuthenticationFilter); it does not create a user or skip the login form. Create the first admin via the bootstrap endpoint, gated by SECURITY_ADMIN_BOOTSTRAP_ENABLED=true + ADMIN_BOOTSTRAP_SECRET, and only callable from localhost:

Read the full file on GitHub · 1,207 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.

1mo ago Changed · +120 lines · +2,333 tokens per session 809c0f6be16a
1mo ago Changed · +20 lines · +402 tokens per session 9c1fe755e5f8
1mo ago Changed · +64 lines · +1,158 tokens per session c6a7ce6307d7
1mo ago Changed · +1 lines · +259 tokens per session c7f2cd3c207a
2mo ago Changed · +80 lines · +1,541 tokens per session 7d2fe9f1a302
2mo ago First seen · 922 lines · 16,976 tokens per session scan B d42d13a212ad

Subscribe to this mod's changes

deepsql CLAUDE.md is an instructions file published in the GitHub repository DeepSQLAI/deepsql (40 stars, last pushed 5d ago), licensed Apache-2.0. It adds 22,669 tokens to every session, about $0.0907 per session on Opus 5.5. A static security scan graded it B with 2 findings (asks for root, makes network calls). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.

Backend and APIs Databases Frontend LLM ai database-performance mcp-server mysql

deepsql CLAUDE.md next to 6 instructions from other repositories
Mod	Type	Stars	Last push	Licence	Scan	Tokens	Works with
deepsql CLAUDE.mdDeepSQLAI/deepsql	Instructions file	40	5d ago	Apache-2.0	B	22,669	Claude Code
vscode buildNext.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	9,719	GitHub Copilot
next.js AGENTS.mdvercel/next.js	Instructions file	143k	yesterday	MIT	A	7,461	Codex, OpenCode
langchain AGENTS.mdlangchain-ai/langchain	Instructions file	149k	yesterday	MIT	A	4,680	Codex, OpenCode
vscode oss-third-party-notices.instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	5,516	GitHub Copilot
vscode copilot-instructions.mdmicrosoft/vscode	Instructions file	195k	yesterday	MIT	A	3,093	GitHub Copilot
deepseek-harness AGENTS.mddeepseek-ai/deepseek-harness	Instructions file	274k	2d ago	MIT	A	4,313	Codex, OpenCode

deepsql: Instructions file for Claude Code