Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

18 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸ—„οΈ sqlmate-mcp

Give Claude a database. Give yourself a GUI.

Zero-config SQL database MCP server with a live browser GUI β€” for Claude Code, Zed, and any MCP client.

Point it at your project, and Claude can explore your MySQL Β· MariaDB Β· SQLite Β· MSSQL Β· PostgreSQL databases while you browse, edit, and query them in a beautiful browser dashboard that updates in real time.


Node.js MCP License: MIT npm


npm install -g sqlmate-mcp
claude mcp add --transport stdio sqlmate-mcp sqlmate-mcp

That's the whole setup. It reads your existing .env β€” no config files to write.


sqlmate-mcp browser GUI β€” paginated data grid with a live feed of Claude's tool calls

✨ Why sqlmate-mcp?

Most database MCP servers give the AI tools and leave you in the dark. sqlmate-mcp does both halves:

  • πŸ€– For Claude β€” 8 focused tools to inspect schemas, run queries, and make guarded writes.
  • πŸ‘€ For you β€” a browser GUI that opens automatically, so you can watch what the agent touches, edit data by hand, and run your own SQL side by side.

No API keys. No cloud. No node-gyp. It reads the config you already have.


πŸš€ Features

⚑ Zero config Reads DB_* vars or DATABASE_URL straight from your project's .env
πŸ”Œ 5 databases MySQL, MariaDB, SQLite, MSSQL, and PostgreSQL from one server
🧠 Schema intelligence get_schema returns every table's columns, PKs, foreign keys, and indexes in a single call
πŸ“Š Query plans explain_query returns the execution plan without running your statement β€” opt into analyze for real timing
πŸ›‘οΈ Write safety DELETE/UPDATE without WHERE, DROP, and TRUNCATE require explicit confirmation
πŸ–₯️ Browser GUI Paginated grid, inline cell editing, row delete, schema view, and a SQL editor with EXPLAIN + timing
πŸ•ΈοΈ ERD visualizer Interactive entity-relationship diagram per connection, with foreign-key edges and click-to-open tables
πŸ—‚οΈ Unified dashboard Open several projects at once and see them all in one GUI, grouped by project
πŸ“‘ Live agent feed Watch every MCP tool call stream into the browser in real time
πŸͺΆ No native builds SQLite uses Node's built-in node:sqlite β€” nothing to compile

πŸ“¦ Setup

1. Install

npm install -g sqlmate-mcp

2. Register with your editor

Claude Code
claude mcp add --transport stdio sqlmate-mcp sqlmate-mcp
Zed

Open your Zed settings.json (Cmd/Ctrl + ,) and add:

{
  "context_servers": {
    "sqlmate-mcp": {
      "command": "sqlmate-mcp",
      "args": [],
      "env": {}
    }
  }
}

To pin a specific project's database, set SQLMATE_PROJECT_ROOT in the env block:

{
  "context_servers": {
    "sqlmate-mcp": {
      "command": "sqlmate-mcp",
      "args": [],
      "env": { "SQLMATE_PROJECT_ROOT": "/absolute/path/to/your/project" }
    }
  }
}

The sqlmate-mcp tools then appear in the Zed Agent Panel.

3. That's it

sqlmate-mcp reads connections from the root of whichever project you open (the directory you launch your editor from). Each project uses its own .env or .sqlmaterc β€” no global config. See Connection Setup.


πŸ”§ Connection Setup

sqlmate-mcp reads connections from your project root at startup (defaults to cwd, override with SQLMATE_PROJECT_ROOT).

Option 1 β€” .env

Laravel-style variables:

DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=myapp
DB_USERNAME=root
DB_PASSWORD=secret

Or a connection URL:

DATABASE_URL=mysql://root:secret@127.0.0.1:3306/myapp
DATABASE_URL=sqlite:///relative/path/app.db
DATABASE_URL=sqlserver://sa:pass@localhost:1433/master
DATABASE_URL=postgres://postgres:secret@127.0.0.1:5432/myapp

Supported schemes: mysql, mariadb, sqlite, sqlserver / mssql, pgsql / postgres / postgresql.

Option 2 β€” .sqlmaterc

A JSON array of connection objects in your project root:

[
  { "name": "Local MySQL", "type": "mysql", "host": "127.0.0.1", "port": 3306, "username": "root", "password": "", "database": "myapp" },
  { "name": "App SQLite", "type": "sqlite", "path": "./database/app.db" },
  { "name": "Local Postgres", "type": "postgres", "host": "127.0.0.1", "port": 5432, "username": "postgres", "password": "", "database": "myapp" }
]

A copy-paste starting point lives in docs/sqlmaterc-example.json.


πŸ› οΈ MCP Tools

Tool Description
list_connections List all detected connections (id, name, type, source)
add_connection Add a connection for the session via URL, config file, or params
list_tables(connectionId) List table names for a connection
describe_table(connectionId, table) Column names, types, nullability, and primary key info
get_schema(connectionId, [table]) Full schema graph β€” columns, PKs, foreign keys, and indexes
run_query(connectionId, sql) Run a read-only query (SELECT, EXPLAIN, SHOW, PRAGMA)
explain_query(connectionId, sql, [analyze]) Return the execution plan; analyze runs read-only statements for real timing
run_write(connectionId, sql) Run an INSERT, UPDATE, DELETE, or DDL statement

run_write runs a risk assessment first. Operations affecting all rows (no WHERE), DROP, TRUNCATE, or ALTER…DROP COLUMN pause and ask Claude to confirm with confirm: true before proceeding.


πŸ–₯️ Browser GUI

Opens automatically at http://localhost:4737 on startup.

  • πŸ“„ Browse any table with a paginated data grid
  • ✏️ Click a cell to edit it inline; delete rows with the trash icon
  • πŸ”€ Toggle between data view and column schema view
  • πŸ’¬ Run arbitrary SQL in the built-in editor, with Explain for the plan and per-query timing
  • πŸ•ΈοΈ Visualize a database as an interactive ERD β€” PK/FK badges, relationship edges, click-to-open
  • πŸ”„ Reconnect a database without restarting the server
  • πŸ“‘ Watch a live feed of every MCP tool call Claude makes
Built-in SQL editor with query results, timing, and an Explain button
SQL editor β€” run queries with EXPLAIN and per-query timing
Column schema view showing types, nullability, and primary keys
Schema view β€” columns, types, nullability, and keys

Interactive entity-relationship diagram with foreign-key edges and a minimap

ERD visualizer β€” an interactive diagram of every table and its relationships

πŸ—‚οΈ Multiple Projects, One Dashboard

Open your editor in more than one project at a time and each runs its own sqlmate-mcp process β€” but you only ever see one browser GUI, showing all projects at once.

  • The first process to start binds the GUI port (SQLMATE_PORT, default 4737), becomes the host, and opens the browser.
  • Every other process detects the port is taken, confirms it's a compatible sqlmate-mcp host, and attaches β€” no second tab, no error.
  • The sidebar groups connections by project (each labeled with its host/database); open tables, run SQL, and view ERDs across projects side by side. The live feed spans every project, labeled by project.
  • If the host exits, a remaining attached process automatically takes over β€” the GUI keeps working.

Fully automatic, zero configuration.


βš™οΈ Environment Variables

Variable Default Description
SQLMATE_PROJECT_ROOT cwd Directory to search for .env and .sqlmaterc
SQLMATE_PORT 4737 Port for the browser GUI
SQLMATE_NO_OPEN β€” Set to 1 to skip auto-opening the browser

πŸ§‘β€πŸ’» Development

git clone https://github.com/adamrpostjr/sqlmate-mcp.git
cd sqlmate-mcp
npm install
npm run build      # builds the Svelte GUI into /public

node src/index.js  # start the backend (serves the GUI at :4737)

cd frontend && npm run dev   # frontend hot-reload (proxies /api to :4737)

The frontend is Svelte 5 + Vite + Tailwind. Production build output goes to /public, served statically by Express. Backend is pure Node.js ES modules β€” no TypeScript, no build step.


πŸ“‹ Requirements

  • Node.js β‰₯ 22.5 (for the native node:sqlite module)

πŸ“„ License

MIT Β Β·Β  Built by Adam Post

If sqlmate-mcp saves you a trip to a database client, consider giving it a ⭐