deepsql AGENTS.md

Repository instructions for DeepSQL, a database performance assistant with a Java backend and React frontend. A monorepo is one repository containing multiple related parts of a project.

In plain words
What is it for?
They are for starting the backend and frontend, running backend tests and linting, and starting the PostgreSQL database used by the project.
Why use it?
They give agents a quick map of the codebase, supported databases, technologies, and commands for development and testing.

Instructions file for CodexOpenCode

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/deepsqlai/deepsql/agents-md
Clone the repo
git clone --depth 1 https://github.com/DeepSQLAI/deepsql

Made for: Codex, OpenCode.

Per session 5,352 This file is loaded in full into every session.
When invoked 5,352 The same file — it is already loaded in full.
Security scan D 3 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.05352 $0.05352
Opus 5 $0.02676 $0.02676
Sonnet 5 $0.01070 $0.01070
Haiku 4.5 $0.00535 $0.00535

Measured yesterday against content hash ec8247a1889a, method: parsed. Prices are Anthropic first-party input rates as of 2026-08-30, from the pricing page.

Security

Grade D, and why

deepsql AGENTS.md scanned grade D with 3 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 yesterday.

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.

- **PostgreSQL 16** (vault DB, port 5432): start with `sudo pg_ctlcluster 16 main start`.

Downloads and executes remote codehighSupply chain

curl | sh runs whatever the server returns today, which is not necessarily what it returned when this was reviewed.

`curl -fsSL https://hermes-agent.nousresearch.com/install.sh | bash -s -- --non-interactive --skip-setup`,

Makes network callslowCapability

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

VM so `curl http://127.0.0.1:3000` fails even though Vite looks healthy. Vite proxies
AGENTS.md · 336 lines

How it starts

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

AGENTS.md

Persistent, high-level understanding of this codebase for all AI agents (Codex, Claude, Cursor, Antigravity). For comprehensive details, see docs/root/CLAUDE.md. For development commands and key rules, see CLAUDE.md.

Project Overview

DBA Agent — AI-powered Database Performance Assistant with autonomous troubleshooting.

  • Monorepo: Java backend (backend/) + React frontend (src/)
  • 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, Zustand, TanStack Query v5
  • AI: Azure OpenAI (gpt-5.4-pro, text-embedding-3-large), Azure AI Search (RAG)
  • Databases supported: PostgreSQL, MySQL (extensible via provider registry)

Commands

# Backend
cd backend && mvn spring-boot:run          # Start backend (localhost:8080)
cd backend && mvn test                      # Run tests (143 tests, ~31 min)

# Frontend
npm install && npm run dev                  # Start frontend (localhost:3000)
npm run lint                                # Lint

# Database
docker compose up -d postgres               # Start vault DB (PostgreSQL)

Backend Architecture (Java)

Entry point: backend/src/main/java/com/dbaagent/DbaAgentApplication.java

Package Map

Package Purpose
controller/ REST endpoints (25+ controllers)
service/ Core business logic
service/brain/ ML-based DB intelligence (workload, config, query, classification)
model/ JPA entities and domain models
repository/ Spring Data JPA repositories
provider/ Database dialect registry — PostgreSQL and MySQL providers
config/ Spring configuration beans
security/ JWT auth, RBAC (VIEWER/EDITOR/ADMIN)
util/ Shared utilities (SQL parsing, normalization)

Key Domains

  • Chat/RAG: SpringAIChatService → ChatClient with advisor chain (memory, feedback, schema, performance, RAG)
  • Connections: ConnectionService manages HikariCP pools per database, SSH tunneling via SshTunnelService
  • Slow Query: Ingestion (SlowLogIngestionService), parsing (SlowQueryLogParserService), fingerprinting (QueryFingerprintService), optimization (QueryOptimizationService)
  • Brain Intelligence: Workload characterization, knob identification, config tuning, cardinality estimation, plan pattern memoization
  • Schema Analysis: 8 classification services (access patterns, anti-patterns, health scores, business domains, data sensitivity, partition readiness, relationships, temporal)
  • Performance Actions: ROI-ranked recommendations from multiple sources (index advisor, slow query analysis, brain config, anti-patterns, key columns)
  • Playbooks: JSON-based automation with scheduled execution and multi-channel alerts
  • Monitoring: Growth anomaly detection, performance insights, schema change tracking

Read the full file on GitHub · 336 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. yesterday First seen · 336 lines · 5,352 tokens per session scan D ec8247a1889a

Subscribe to this mod's changes

deepsql AGENTS.md is an instructions file published in the GitHub repository DeepSQLAI/deepsql (23 stars, last pushed 2d ago), licensed Apache-2.0. It adds 5,352 tokens to every session, about $0.0268 per session on Opus 5. A static security scan graded it D with 3 findings (asks for root, downloads and executes remote code, makes network calls). No closer match exists in the catalogue, so it is treated as the original; first seen 2026-08-30.