SQL MCP Server

# Changelog All notable changes to this project will be documented in this file. ## [1.4.0] - 2025-08-13 ### Added - SQL Tutor Advisor framework: - PlanAnalyzer: parse EXPLAIN(JSON) → summary/risks/signals - IndexAdvisor: plan + SQL shape → graded suggestions (filters/join/order) with alias mapping - QueryRewriter: read-only rewrites (avoid SELECT *, keyset template, leading LIKE warning, SARGable examples) - Tools: - `indexAdvisor(sql)`: dedicated index suggestions (text + advisor-evidence.json) - `rewriteQuery(sql)`: dedicated rewrite proposals (text + advisor-evidence.json) - `doctor()`: connectivity/read-only/EXPLAIN checks + duplicate/redundant index scan; CLI flag `--doctor` ### Changed - `optimizeQuery`: unified evidence JSON (plan/analysis/suggestions/rewrites); includes duplicate/redundant index findings per table - README: documented new tools and evidence JSON contract ### Tests - Unit tests for PlanAnalyzer, SqlTutorHandler (explain/optimize), QueryRewriter, server tool registry - Added redundancy/dedup index suggestions test ## [1.3.0] - 2025-08-12 ### Added - **CLI: DSN support** (`--dsn mysql://user:pass@host:port/dbname`) with explicit flags overriding DSN parts. - **Demo environment**: `docker compose` with auto-initialized sample e-commerce schema (`demo/init.sql`), healthcheck, and service dependency on MySQL readiness. - **MCP Inspector guide** in README for HTTP and stdio modes. ### Changed - **HTTP content compliance**: Replaced non-standard `{ type: "json" }` results with MCP-compliant `{ type: "resource", mimeType: "application/json", text }` in query/sample handlers. - **Fuzzy search UX**: When no `%`/`_` in pattern, defaults to substring match (case-insensitive). `%`/`_` still supported for LIKE semantics. - **Identifier validation**: Trim input and provide clearer error when empty. - **Docs**: README enhanced with Demo quickstart, DSN usage, Inspector steps, and troubleshooting. ### Fixed - Race on startup where SQL-MCP tried connecting before MySQL was ready (added healthcheck and `depends_on: service_healthy`). ## [1.2.1] - 2025-08-11 ### Documentation - **Comprehensive README Overhaul**: The `README.md` has been completely rewritten for better clarity, structure, and readability. - **Cursor Integration Guide**: Added a new section with detailed instructions and examples for integrating with Cursor using both `stdio` and `http` modes. - **Improved Configuration Details**: Re-introduced and enhanced the environment variable reference table, making configuration more transparent. - **Refined Project Description**: Updated the core project description to more accurately define SQL-MCP's role as a bridge between LLMs and databases. ## [1.2.0] - 2025-08-11 - Stdio experience: - New flags: `--stdio-safe`, `--compact`, `--json-only` - `executeQuery` supports `limit/offset` with JSON meta (`limit/offset/nextOffset/hasMore/durationMs/columns/data`) - Tools: - `searchTables(pattern)`, `searchColumns(pattern)` for quick discovery - `refreshCache(scope=all|table)` to refresh metadata cache - Startup: - Background prewarm of table list (`cache.prewarmOnStart`, `SQL_MCP_CACHE_PREWARM_ON_START`) - Config: - `security.queryMaxRows` caps `executeQuery` page size - Docs/Tests: - README updated for stdio flags, tools, pagination; tests adjusted and all green ## [1.1.0] - 2025-08-10 - Logging: - Slow query threshold `logging.slowQueryMs` with warn-level logging - Structured HTTP request logs (`logging.httpRequests`) - HTTP Security: - Optional API Key(s): `mcp.httpApiKey` / `mcp.httpApiKeys` - DNS Rebinding/Host allowlist: `mcp.enableDnsRebindingProtection`, `mcp.allowedHosts` - CORS allowlist: `mcp.corsAllowedOrigins` - Rate Limiting: - In-memory middleware for `/mcp` with `security.rateLimit.{enabled,windowMs,max,perIpMax}` - DB Connector: - Configurable pool: `database.pool.{connectionLimit,waitForConnections,queueLimit}` - Query timeout `security.queryTimeoutMs` - Sampling: - `SampleDataHandler` now also returns JSON payload with `nextOffset` alongside markdown - Packaging/CI: - Package scoped to `@polarisxb/sql-mcp` - Docker workflow: explicit Dockerfile + Buildx container driver + inline cache - CI/Release: use `npm run build` with `tsconfig.build.json` (exclude tests) - Docs: - README: badges, Chinese-first with English section; CLI/env tables ## [1.0.1] - 2025-08-09 - Initial public release of SQL-MCP - MySQL connector, services (metadata/sampler/security) - MCP integration: tools/resources, stdio/http transports - E2E/units green; Dockerfile multi-stage build --- Dates use UTC. See repository history for detailed commits.