Skip to content

Commit 0f99014

Browse files
docs: lead with what DeepSQL does, matched to the site hero
Rewrite "What it does" around the product framing on deepsql.ai: a 24/7 DBA and data engineer that answers BI questions, fixes slow queries and watches your schema, all from one shared brain. Move the section above Quick start so the README reads intro, capabilities, install. Promote the MCP server subsection to a top-level heading now that its parent moved.
1 parent fbb26c9 commit 0f99014

1 file changed

Lines changed: 31 additions & 19 deletions

File tree

README.md

Lines changed: 31 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,36 @@ reasoning behind it.
1717

1818
---
1919

20+
## What it does
21+
22+
Your 24/7 DBA and data engineer. It answers BI questions, fixes slow queries, and watches
23+
your schema — all from one shared brain.
24+
25+
- **Answers BI questions.** Ask in plain English. The agent loads your business context,
26+
resolves the schema, drafts and validates SQL, then executes it read-only — with every
27+
step you can inspect. The hand-written SQL editor is the only path that can mutate, and
28+
only for a confirming admin.
29+
- **Fixes slow queries.** Reads `pg_stat_statements` or the MySQL slow log, groups queries
30+
by fingerprint, ranks them by cost, and flags regressions against their baseline.
31+
- **Index recommendations.** Advises, and can apply them for you — `CREATE INDEX
32+
CONCURRENTLY` on PostgreSQL, so no table lock.
33+
- **Watches your schema.** Tracks what changed and what needs attention, so drift surfaces
34+
before it breaks a query or a dashboard.
35+
- **A brain that knows your business.** Teach it your metrics, rules and conventions once —
36+
MRR, active accounts, currency handling — and every query, dashboard and recommendation
37+
uses the same governed definitions.
38+
- **Dashboards without the analyst backlog.** An agent writes a single self-contained HTML
39+
document, rendered in a sandboxed iframe with no network access. It reads data only
40+
through a read-only query bridge back to the backend — the agent gets creative freedom,
41+
the database keeps its guard rail.
42+
- **Ask it from anywhere.** The web UI, your terminal, or a Slack channel. The MCP server
43+
gives coding agents (Claude Code, Cursor, Codex, Claude Desktop) the same capabilities
44+
over stdio.
45+
- **Postgres and MySQL, in your infra.** One dialect registry, read-only execution, and SSH
46+
tunnelling to reach databases behind a bastion.
47+
48+
---
49+
2050
## Quick start
2151

2252
There are no prebuilt images and no container registry. Docker Compose builds the backend
@@ -143,25 +173,7 @@ version), `_USE_RESPONSES_API` (`true` / `false` / `auto`).
143173
144174
---
145175

146-
## What it does
147-
148-
- **Ask in English.** Schema questions, business questions, "why is this slow" questions.
149-
SQL that the assistant or an agent generates is validated and executed read-only; the
150-
hand-written SQL editor is the only path that can mutate, and only for a confirming admin.
151-
- **Slow query analysis.** Ingests and groups slow queries, attributes cost, and explains
152-
what is actually expensive.
153-
- **Index recommendations.** Advises, and can apply them for you — `CREATE INDEX
154-
CONCURRENTLY` on PostgreSQL, so no table lock.
155-
- **Generated dashboards.** An agent writes a single self-contained HTML document, rendered
156-
in a sandboxed iframe with no network access. It reads data only through a read-only query
157-
bridge back to the backend — the agent gets creative freedom, the database keeps its guard
158-
rail.
159-
- **MCP server.** Gives coding agents (Claude Code, Cursor, Codex, Claude Desktop) the same
160-
capabilities over stdio.
161-
- **SSH tunnelling.** Reach databases behind a bastion without exposing them.
162-
- **PostgreSQL and MySQL**, behind one dialect registry.
163-
164-
### MCP server
176+
## MCP server
165177

166178
The server lives in `mcp/` and exposes 44 tools that wrap the backend API, so agents reuse
167179
the same orchestration, retrieval and guardrails instead of getting raw database

0 commit comments

Comments
 (0)