Skip to main content

Read-only Model Context Protocol server for SQL databases. Lets LLMs (Claude, Cursor, ChatGPT, Continue) introspect and query SQL Server, Postgres, and SQLite with multi-layer safety guards including sql-sop linting.

Project description

sql-explorer-mcp

PyPI Python License

Read-only Model Context Protocol server for SQL databases. Lets LLMs (Claude, Cursor, ChatGPT, Continue) introspect and query SQL Server, Postgres, and SQLite with three layers of safety:

  1. Connection-level read-onlypyodbc readonly=True, Postgres SET TRANSACTION READ ONLY
  2. AST validation — sqlglot parses every query and rejects anything that isn't a SELECT (catches DML smuggled in CTEs)
  3. Linter passsql-sop checks every query and rejects error-severity findings; warnings are surfaced to the LLM as advisory output

Multi-server: configure several databases in one servers.yaml, the LLM picks which one to target per call.

Tools exposed to the LLM

Tool Purpose
list_servers() Enumerate configured servers + their dialect
list_databases(server?) List databases on a server
list_tables(server?, database?, schema?) List tables, optionally filtered by schema
describe_table(table, server?, schema?) Columns, types, nullability, defaults
get_table_sample(table, n=10, server?, schema?) Quick SELECT TOP n / LIMIT n
run_query(sql, server?) Execute arbitrary SELECT — three-layer safety stack
explain_query(sql, server?) Return execution plan (engine-specific)
search_objects(query, server?) Find tables and columns by name fragment

All tools accept an optional server to target a specific entry from servers.yaml. Default server is used when omitted.

Install

pip install sql-explorer-mcp
# or
pipx install sql-explorer-mcp

For SQL Server, install Microsoft ODBC Driver 18. Postgres and SQLite drivers ship as dependencies.

Configure

Copy servers.example.yaml to servers.yaml and edit. Passwords are read from environment variables, never stored in the file.

default_server: lab

servers:
  lab:
    dialect: mssql
    host: localhost
    port: 1433
    database: BusinessLab
    auth: sql
    username: sa
    password_env: SQL_EXPLORER_LAB_PASSWORD

  production:
    dialect: mssql
    host: BUSINESS-SQL
    database: SI
    auth: windows               # uses Trusted_Connection
    max_rows: 500

  warehouse:
    dialect: postgres
    host: db.internal
    database: warehouse
    username: readonly
    password_env: WAREHOUSE_PG_PASSWORD

The config file is searched in this order:

  1. $SQL_EXPLORER_CONFIG if set
  2. ./servers.yaml (current directory)
  3. ~/.sql-explorer-mcp/servers.yaml

Run

As an MCP server for Claude Desktop

Add to ~/Library/Application Support/Claude/claude_desktop_config.json (Mac) or %APPDATA%\Claude\claude_desktop_config.json (Windows):

{
  "mcpServers": {
    "sql-explorer": {
      "command": "sql-explorer-mcp",
      "env": {
        "SQL_EXPLORER_CONFIG": "/full/path/to/servers.yaml",
        "SQL_EXPLORER_LAB_PASSWORD": "your-lab-password"
      }
    }
  }
}

Restart Claude Desktop. The seven tools appear under Settings → Tools.

As an MCP server for Cursor

Add to .cursor/mcp.json:

{
  "mcpServers": {
    "sql-explorer": {
      "command": "sql-explorer-mcp",
      "env": { "SQL_EXPLORER_CONFIG": "/full/path/to/servers.yaml" }
    }
  }
}

Standalone (debug)

sql-explorer-mcp

Reads stdin/stdout in MCP protocol. Use the MCP Inspector to test interactively:

npx @modelcontextprotocol/inspector sql-explorer-mcp

Safety architecture

LLM submits SQL
       │
       ▼
┌──────────────────┐
│ Layer 2 (sqlglot)│  Parse, reject if not exactly one SELECT
└────────┬─────────┘  Catches: INSERT, UPDATE, DELETE, MERGE, EXEC,
         │            CREATE, DROP, ALTER, smuggled DML in CTEs,
         │            multiple statements
         ▼
┌──────────────────┐
│ Layer 3 (sql-sop)│  Lint, reject if any error-severity findings
└────────┬─────────┘  Warnings (W*) returned as advisory output,
         │            don't block execution.
         ▼
┌──────────────────┐
│ Layer 1 (driver) │  pyodbc readonly=True / Postgres SET TXN READ ONLY
└────────┬─────────┘  Final defence at the protocol layer.
         ▼
   Database
         │
         ▼
   Result rows (capped at server.max_rows)

Failure at any layer returns a structured result the LLM can read and react to:

{
  "passed": false,
  "layer": "select-only",
  "reason": "Forbidden statement type in query: Delete"
}

Why this design

  • Read-only by enforcement, not convention. A misconfigured login isn't your only protection.
  • Multi-engine from day 1. Same tool surface across SQL Server, Postgres, SQLite. Same servers.yaml.
  • Multi-server in one process. Switch between lab and production by passing server="production" instead of restarting.
  • Linter-aware. Uses sql-sop to flag patterns that compile fine but signal poor query habits (SELECT *, unbounded queries, etc.).
  • Result caps. Every tool clamps row counts (max 1000 default) so a curious LLM can't pull 100k rows into context.

Comparison to other SQL MCP servers

Server Dialects Read-only Linter pass Multi-server
sql-explorer-mcp mssql, postgres, sqlite ✓ (3 layers) ✓ via sql-sop
various community mssql-mcp mssql depends usually ✗
various postgres-mcp postgres depends usually ✗

Development

git clone https://github.com/Pawansingh3889/sql-explorer-mcp
cd sql-explorer-mcp
pip install -e ".[dev]"
pytest -v

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sql_explorer_mcp-0.1.0.tar.gz (15.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sql_explorer_mcp-0.1.0-py3-none-any.whl (15.3 kB view details)

Uploaded Python 3

File details

Details for the file sql_explorer_mcp-0.1.0.tar.gz.

File metadata

  • Download URL: sql_explorer_mcp-0.1.0.tar.gz
  • Upload date:
  • Size: 15.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for sql_explorer_mcp-0.1.0.tar.gz
Algorithm Hash digest
SHA256 332b6ac5d09931bdc9850a19391cbd0281ba4dae4700b350d03ea209ba819913
MD5 a22b219d4736c8a77e23809f921f349a
BLAKE2b-256 fad4dde5c2b75e0a8f9903d6f41c1e3bf11ccd726a5daa1a990643297666aebf

See more details on using hashes here.

Provenance

The following attestation bundles were made for sql_explorer_mcp-0.1.0.tar.gz:

Publisher: release.yml on Pawansingh3889/sql-explorer-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file sql_explorer_mcp-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for sql_explorer_mcp-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6790ab7eb94d187dec5be0d793242df409a7d3723e82686d93c28784fb9b9d70
MD5 d1e898467fc634fee8c225db7467afa2
BLAKE2b-256 b7a7491be0e87060a0630f85e55643ca872374e0d8381cb71c3466b5f28cfe0d

See more details on using hashes here.

Provenance

The following attestation bundles were made for sql_explorer_mcp-0.1.0-py3-none-any.whl:

Publisher: release.yml on Pawansingh3889/sql-explorer-mcp

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page