sqldb-mcp-server
Enables read-only SQL database access to MySQL databases, supporting SELECT queries, table listing, schema description, query explanation, and export of results to CSV/JSON/Markdown.
Enables read-only SQL database access to PostgreSQL databases, supporting SELECT queries, table listing, schema description, query explanation, and export of results to CSV/JSON/Markdown.
Click on "Install Server".
Wait a few minutes for the server to deploy. Once ready, it will show a "Started" state.
In the chat, type
@followed by the MCP server name and your instructions, e.g., "@sqldb-mcp-servershow me the first 10 users"
That's it! The server will respond to your query, and you can continue using it as needed.
Here is a step-by-step guide with screenshots.
sqldb-mcp-server
A read-only Model Context Protocol (MCP) server that exposes SQL database access to LLMs.
Features
Multi-database – supports MSSQL, PostgreSQL, and MySQL
Read-only – only
SELECTstatements are allowed (enforced via AST-level SQL parsing with the correct dialect per DB type)LLM-optimised – results use a compact columnar format (column list + value rows) to reduce token usage
Pagination –
skip/takeparameters with automatic cap at 100 rowsTotal-count aware – every query result includes
meta.totalCountso the LLM knows how many rows existCaching – query / schema results are cached with a configurable TTL
File export – stream query results to CSV or JSON files without a row-count limit
Markdown evidence export – save SQL and query results as a Markdown report file for test evidence
Six MCP tools:
query,listTables,describeTable,explainQuery,exportQuery,saveQueryEvidence
Related MCP server: MCP SQL Server
Installation
From npm (recommended)
# Install globally
npm install -g @akrym1582/sqldb-mcp-server
# Or run directly with npx (no install needed)
npx @akrym1582/sqldb-mcp-serverFrom source
git clone https://github.com/akrym1582/sqldb-mcp-server.git
cd sqldb-mcp-server
npm install
npm run buildQuick Start
# 1. Install globally
npm install -g @akrym1582/sqldb-mcp-server
# 2. Configure environment variables (see below)
export DB_TYPE=postgresql
export DB_HOST=localhost
export DB_USER=myuser
export DB_PASSWORD=mypassword
export DB_NAME=mydb
# 3. Run
sqldb-mcp-serverOr use in your MCP client configuration (e.g. Claude Desktop claude_desktop_config.json):
{
"mcpServers": {
"sqldb": {
"command": "npx",
"args": ["-y", "@akrym1582/sqldb-mcp-server"],
"env": {
"DB_TYPE": "postgresql",
"DB_HOST": "localhost",
"DB_PORT": "5432",
"DB_USER": "myuser",
"DB_PASSWORD": "mypassword",
"DB_NAME": "mydb"
}
}
}
}Environment Variables
Variable | Default | Description |
|
| Database type: |
| – | Database server hostname |
|
| Database server port (default depends on |
| – | Database username |
| – | Database password |
| – | Database name |
|
| Enables encrypted DB connections. MSSQL trusts the server certificate. PostgreSQL tries SSL first and falls back to plain if SSL is unavailable. MySQL uses TLS with certificate verification disabled when enabled. |
|
| Query timeout in milliseconds (used by |
|
| Export query timeout in milliseconds (used by |
|
| Cache TTL in seconds |
Default ports by DB type
| Default |
|
|
|
|
|
|
MCP Tools
query
Execute a SELECT SQL statement.
{
"sql": "SELECT id, name FROM users WHERE active = 1",
"skip": 0,
"take": 10
}Response format (compact / token-efficient):
{
"meta": { "totalCount": 42, "returnedCount": 10, "skip": 0, "take": 10 },
"columns": ["id", "name"],
"rows": [[1, "Alice"], [2, "Bob"], ...]
}listTables
List all base tables in the database.
[{ "schema": "dbo", "name": "users" }, ...]describeTable
Describe a table's columns, indexes, foreign keys, check constraints, and size statistics.
{ "table": "dbo.users" }explainQuery
Return the estimated execution plan for a SELECT query without executing it.
{ "sql": "SELECT * FROM orders WHERE status = 'open'" }exportQuery
Stream a SELECT query result to a file. Designed for large datasets – there is no row-count limit and results are written directly to disk using Node.js streams.
{
"sql": "SELECT * FROM large_table",
"filepath": "/tmp/export.csv",
"format": "csv",
"options": { "delimiter": ",", "bom": false }
}format defaults to "csv" if omitted. "json" is also supported.
CSV options (all optional):
Option | Default | Description |
|
| Column separator |
|
| String to write for |
|
| Prepend UTF-8 BOM (useful for Excel) |
JSON options (all optional):
Option | Default | Description |
|
| Indent the output JSON |
Response format:
{
"filepath": "/tmp/export.csv",
"format": "csv",
"rowCount": 50000
}The tool uses a separate, longer-lived connection pool whose requestTimeout is controlled by EXPORT_QUERY_TIMEOUT (default 300 000 ms = 5 min). Increase this value for very large exports.
saveQueryEvidence
Execute a SELECT query and save the SQL plus the returned rows as a Markdown report file for test evidence.
{
"sql": "SELECT id, name FROM users LIMIT 10",
"filepath": "/tmp/query-evidence.md"
}Response format:
{
"filepath": "/tmp/query-evidence.md",
"rowCount": 10,
"previewRows": [
{ "id": 1, "name": "Alice" },
{ "id": 2, "name": "Bob" }
]
}If an error occurs, the tool returns the error message text instead of a success payload.
Development
# Clone the repository
git clone https://github.com/akrym1582/sqldb-mcp-server.git
cd sqldb-mcp-server
# Install dependencies
npm install
# Configure environment
cp .env.example .env
# Edit .env with your DB credentials
# Run in dev mode (no compile step)
npm run dev
# Or build and run
npm run build
npm start
# Run unit tests
npm testProject Structure
src/
mcp/
server.ts # MCP server entry point
tools/
query.ts # query tool
listTables.ts # listTables tool
describeTable.ts # describeTable tool
explainQuery.ts # explainQuery tool
exportQuery.ts # exportQuery tool (streaming file export)
db/
index.ts # DB adapter factory (selects adapter from DB_TYPE)
types.ts # DB interfaces (including queryStream)
adapters/
mssql.ts # Microsoft SQL Server implementation
postgresql.ts # PostgreSQL implementation (pg + pg-cursor)
mysql.ts # MySQL implementation (mysql2)
utils/
row-result.ts # Compact columnar result format
sanitize.ts # AST-based SQL read-only validation (dialect-aware)
pagination.ts # skip/take normalisation
cache.ts # TTL in-memory cache
export-writer.ts # Streaming CSV / JSON file writer
__tests__/ # Unit testsThis server cannot be installed
Maintenance
Resources
Unclaimed servers have limited discoverability.
Looking for Admin?
If you are the server author, to access and configure the admin panel.
Latest Blog Posts
- Your AI Chatbot Just Exposed Your CEO's Salary to an InternBy Om-Shree-0709 on .Agent IdentityMCP SecurityOAuth Delegation
- Why MCP Servers Need Execution Sandboxing (And Why Your Current Stack Isn't Enough)By Om-Shree-0709 on .Agentic AiPrompt InjectionWebAssembly
MCP directory API
We provide all the information about MCP servers via our MCP API.
curl -X GET 'https://glama.ai/api/mcp/v1/servers/akrym1582/sqldb-mcp-server'
If you have feedback or need assistance with the MCP directory API, please join our Discord server