{
  "markdown": "# db-mcp (SQLite MCP Server)\n\n<!-- mcp-name: io.github.neverinfamous/db-mcp -->\n\n**SQLite MCP Server** with 170+ specialized tools, 11 data resources + 11 help resources, and 10 prompts, audit logging with DDL backup snapshots, HTTP/SSE Transport, OAuth 2.1 authentication, tool filtering, granular access control, and structured error handling with categorized, actionable responses. Available in WASM and better-sqlite3 variants.\n\n[![GitHub](https://img.shields.io/badge/GitHub-neverinfamous/db--mcp-blue?logo=github)](https://github.com/neverinfamous/db-mcp)\n![GitHub Release](https://img.shields.io/github/v/release/neverinfamous/db-mcp)\n[![npm](https://img.shields.io/npm/v/db-mcp)](https://www.npmjs.com/package/db-mcp)\n[![Docker Pulls](https://img.shields.io/docker/pulls/writenotenow/db-mcp)](https://hub.docker.com/r/writenotenow/db-mcp)\n[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)\n![Status](https://img.shields.io/badge/status-Production%2FStable-brightgreen)\n[![MCP](https://img.shields.io/badge/MCP-Registry-green.svg)](https://registry.modelcontextprotocol.io/v0/servers?search=io.github.neverinfamous/db-mcp)\n[![Security](https://img.shields.io/badge/Security-Enhanced-green.svg)](SECURITY.md)\n[![TypeScript](https://img.shields.io/badge/TypeScript-Strict-blue.svg)](https://github.com/neverinfamous/db-mcp)\n[![E2E](https://github.com/neverinfamous/db-mcp/actions/workflows/e2e.yml/badge.svg)](https://github.com/neverinfamous/db-mcp/actions/workflows/e2e.yml)\n[![Tests](https://img.shields.io/badge/Tests-1911%20passed-brightgreen.svg)](https://github.com/neverinfamous/db-mcp)\n[![Coverage](https://img.shields.io/badge/Coverage-90.04%25-green.svg)](https://github.com/neverinfamous/db-mcp)\n\n**[Wiki](https://github.com/neverinfamous/db-mcp/wiki)** • **[Changelog](CHANGELOG.md)**\n\n---\n\n## 🎯 What Sets Us Apart\n\n| Feature                          | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |\n| -------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **181+ Specialized Tools**       | The most comprehensive SQLite MCP server available — core CRUD, JSON/JSONB, FTS5 full-text search, statistical analysis, vector search, geospatial/SpatiaLite, introspection, migration, and admin                                                                                                                                                                                                                                                                                 |\n| **Deep Observability**           | Built-in Prometheus `/metrics` export, real-time `sqlite://metrics` MCP resource, historical persistence to a `SystemDb` sidecar, and a granular `sqlite_audit_search` tool for compliance and investigation                                                                                                                                                                                                                                                                       |\n| **Dynamic Configuration**        | Full YAML/JSON config file support (`--config`) with precedence rules, plus a `sqlite_server_config` tool for live runtime config updates (e.g., log levels) without server restarts                                                                                                                                                                                                                                                                                               |\n| **Advanced Query & Search**      | O(1) cursor-based keyset pagination, faceted search aggregation, and `sqlite_hybrid_search` orchestrating FTS5 + Vector similarity with Reciprocal Rank Fusion (RRF) in a single tool call                                                                                                                                                                                                                                                                                         |\n| **AI Index Recommendations**     | `sqlite_index_audit` automatically analyzes `EXPLAIN QUERY PLAN` responses to suggest optimized composite and partial indexes based on workload patterns                                                                                                                                                                                                                                                                                                                           |\n| **Real-time Subscriptions**      | Native `resources/subscribe` support pushing event-driven notifications for `sqlite://schema` DDL changes and periodic `sqlite://health` updates directly to clients                                                                                                                                                                                                                                                                                                               |\n| **22 Resources**                 | 11 data resources (schema, tables, table_schema, indexes, views, health, meta, audit, metrics, compile_options, pragma) + 11 help resources (`sqlite://help` + per-group reference) — filtered by `--tool-filter`                                                                                                                                                                                                                                                                  |\n| **10 AI-Powered Prompts**        | Guided workflows for schema exploration, query building, data analysis, optimization, migration, debugging, and hybrid FTS5 + vector search                                                                                                                                                                                                                                                                                                                                        |\n| **Code Mode**                    | **Massive Token Savings:** Execute complex, multi-step operations inside a **V8 isolate sandbox** with process-level isolation and hard timeouts. Instead of spending thousands of tokens on back-and-forth tool calls, Code Mode exposes all 180+ capabilities locally, reducing token overhead by 70–90% and supercharging AI agent reasoning                                                                                                                                    |\n| **Token-Optimized Payloads**     | Every tool response is designed for minimal token footprint with `_meta.tokenEstimate` on every response so agents know their token cost. Tools include `compact`, `nodesOnly`, `maxOutliers`, `minSeverity`, and `maxInvalid` parameters where applicable — letting agents control response size without losing data access                                                                                                                                                       |\n| **Dual SQLite Backends**         | WASM (sql.js) for zero-compilation portability, Native (better-sqlite3) for high-performance concurrent execution with full features including transactions, window functions, and SpatiaLite GIS                                                                                                                                                                                                                                                                                  |\n| **OAuth 2.1 + Access Control**   | Enterprise-ready security with RFC 9728/8414 compliance, granular scopes (`full`, `read`, `write`, `admin`, `db:*`, `table:*:*`), and Keycloak integration                                                                                                                                                                                                                                                                                                                         |\n| **Smart Tool Filtering**         | 10 tool groups + 7 shortcuts let you stay within IDE limits while exposing exactly what you need                                                                                                                                                                                                                                                                                                                                                                                   |\n| **HTTP Streaming Transport**     | Streamable HTTP (`/mcp`) for modern clients + legacy SSE (`/sse`) for backward compatibility — both protocols supported simultaneously with security headers, rate limiting, health check, and stateless mode for serverless                                                                                                                                                                                                                                                       |\n| **Production-Ready Security**    | SQL injection protection (parameterized queries + Unicode-normalized WHERE clause validation), sandboxed code execution (V8 `codeGeneration` restrictions, frozen prototypes, 29 blocked patterns, Proxy nullified, RPC allowlist), CORS deny-all default, fail-closed scope enforcement, JWT claims sanitization, 7 security headers, body size limits, rate limiting with Retry-After, slowloris timeouts, `trustedProxyIps`, opt-in HSTS, non-root Docker, and build provenance |\n| **Encryption at Rest**           | Native SQLCipher support via `--encryption-key` or `DB_ENCRYPTION_KEY`. Dynamically loads `better-sqlite3-multiple-ciphers` and automatically encrypts the sidecar `SystemDb` audit logs to prevent sensitive queries from leaking                                                                                                                                                                                                                                                 |\n| **Strict TypeScript**            | 100% type-safe codebase with strict mode, no `any` types, 1911 unit tests + 1136 E2E tests and 90% coverage                                                                                                                                                                                                                                                                                                                                                                        |\n| **Deterministic Error Handling** | Every tool returns structured `{success, error, code, category, suggestion, recoverable}` responses — no raw exceptions, no silent failures. Agents get enriched error context with actionable suggestions instead of cryptic SQLite codes                                                                                                                                                                                                                                         |\n| **MCP 2025-03-26 Compliant**     | Full protocol support with tool safety hints (`sensitiveHint`, `readOnlyHint`), resource priorities, and progress notifications                                                                                                                                                                                                                                                                                                                                                    |\n\n## 🚀 Quick Start\n\n### Option 1: Docker (Recommended)\n\nPull and run instantly:\n\n```bash\ndocker pull writenotenow/db-mcp:latest\n```\n\nRun with volume mount:\n\n```bash\ndocker run -i --rm \\\n  -v $(pwd):/workspace \\\n  writenotenow/db-mcp:latest \\\n  --sqlite-native /workspace/database.db\n```\n\n### Option 2: Node.js Installation\n\nClone the repository:\n\n```bash\ngit clone https://github.com/neverinfamous/db-mcp.git\n```\n\nNavigate to directory:\n\n```bash\ncd db-mcp\n```\n\nInstall dependencies:\n\n```bash\npnpm install\n```\n\nBuild the project:\n\n```bash\npnpm run build\n```\n\nRun the server with **Native backend** (better-sqlite3 — full features, requires Node.js native build):\n\n```bash\nnode dist/cli.js --transport stdio --sqlite-native ./database.db\n```\n\nOr with **WASM backend** (sql.js — cross-platform, no compilation required):\n\n```bash\nnode dist/cli.js --transport stdio --sqlite ./database.db\n```\n\n> **Backend Choice:** Use `--sqlite-native` for full features (181 MCP tools / 170 group tools, transactions, window functions, SpatiaLite). Use `--sqlite` for WASM mode (154 MCP tools / 143 group tools, no native dependencies).\n\n### Verify It Works\n\n```bash\nnode dist/cli.js --transport stdio --sqlite-native :memory:\n```\n\nExpected output:\n\n```\n[db-mcp] Starting MCP server...\n[db-mcp] Registered adapter: Native SQLite Adapter (better-sqlite3) (sqlite:default)\n[db-mcp] Server started successfully\n```\n\nRun the test suite:\n\n```bash\npnpm run test\n```\n\n### Prerequisites\n\n- ✅ Docker installed and running (for Docker method)\n- ✅ Node.js 24+ (LTS) (for local installation)\n\n## Code Mode: Maximum Efficiency\n\nCode Mode (`sqlite_execute_code`) dramatically reduces token usage (70–90%) and is included by default in all presets.\n\nCode executes in a **worker-thread sandbox** — a separate V8 isolate with its own memory space. All `sqlite.*` API calls are forwarded to the main thread via a `MessagePort`-based RPC bridge, where the actual database operations execute. This provides:\n\n- **Process-level isolation** — user code runs in a separate V8 instance with enforced heap limits\n- **Readonly enforcement** — when `readonly: true`, stripped methods throw clear error messages listing available methods via Proxy traps\n- **Hard timeouts** — worker termination if execution exceeds the configured limit\n- **V8 code generation restrictions** — `eval()` and `Function()` construction from strings disabled at the V8 engine level via `codeGeneration: { strings: false, wasm: false }`\n- **RPC allowlist** — host-side validation prevents workers from invoking unauthorized API methods\n- **Full API access** — all 10 tool groups are available via `sqlite.*` (e.g., `sqlite.core.readQuery()`, `sqlite.json.extract()`)\n\nSet `CODEMODE_ISOLATION=vm` with `CODEMODE_ISOLATION_INSECURE=1` to fall back to the in-process `vm` module sandbox if needed.\n\n### ⚡ Code Mode Only (Maximum Token Savings)\n\nIf you control your own setup, you can run with **only Code Mode enabled** — a single tool that provides access to all 180+ tools' worth of capability through the `sqlite.*` API:\n\n```json\n{\n  \"mcpServers\": {\n    \"db-mcp-sqlite\": {\n      \"command\": \"node\",\n      \"args\": [\n        \"/path/to/db-mcp/dist/cli.js\",\n        \"--transport\",\n        \"stdio\",\n        \"--sqlite-native\",\n        \"/path/to/database.db\",\n        \"--tool-filter\",\n        \"codemode\"\n      ]\n    }\n  }\n}\n```\n\nThis exposes just `sqlite_execute_code` plus built-in tools. The agent writes JavaScript against the typed `sqlite.*` SDK — composing queries, chaining operations across all 10 tool groups, and returning exactly the data it needs — in one execution. This mirrors the [Code Mode pattern](https://blog.cloudflare.com/code-mode-mcp/) pioneered by Cloudflare for their entire API: fixed token cost regardless of how many capabilities exist.\n\n> [!TIP]\n> **Maximize Token Savings:** Instruct your AI agent to prefer Code Mode over individual tool calls:\n>\n> _\"When using db-mcp, prefer `sqlite_execute_code` (Code Mode) for multi-step database operations to minimize token usage.\"_\n\n---\n\n## 🎛️ Tool Filtering\n\n> [!IMPORTANT]\n> **AI-enabled IDEs like Cursor have tool limits.** With 180+ tools in the native backend, you must use tool filtering to stay within limits. Use **shortcuts** or specify **groups** to enable only what you need.\n\n### Quick Start: Recommended Configurations\n\n#### Starter (core + json + text)\n\nIf you prefer individual tool calls, `starter` provides Core + JSON + Text:\n\n```json\n{\n  \"args\": [\"--tool-filter\", \"starter\"]\n}\n```\n\n#### Custom Groups\n\nSpecify exactly the groups you need:\n\n```json\n{\n  \"args\": [\"--tool-filter\", \"core,json,stats\"]\n}\n```\n\n### Shortcuts (Predefined Bundles)\n\n> **Note:** Native includes FTS5 (5), window functions (6), transactions (8), and SpatiaLite (7) not available in WASM.\n\n| Shortcut     | WASM   | Native | + Built-in | What's Included                |\n| ------------ | ------ | ------ | ---------- | ------------------------------ |\n| `starter`    | **65** | **70** | +4         | Core, JSON, Text               |\n| `analytics`  | 67     | 73     | +4         | Core, JSON, Stats              |\n| `search`     | 51     | 56     | +4         | Core, Text, Vector             |\n| `spatial`    | 40     | 47     | +4         | Core, Geo, Vector              |\n| `dev-schema` | 41     | 41     | +4         | Core, Introspection, Migration |\n| `minimal`    | 25     | 25     | +4         | Core only                      |\n| `full`       | 143    | 170    | +4         | Everything enabled             |\n\n### Tool Groups (10 Available)\n\n> **Note:** +4 built-in tools (server_info, server_health, list_adapters, sqlite_execute_code) are injected into every group.\n\n| Group           | WASM | Native | + Built-in | Description                                |\n| --------------- | ---- | ------ | ---------- | ------------------------------------------ |\n| `core`          | 25   | 25     | +4         | Basic CRUD, schema, tables                 |\n| `json`          | 25   | 25     | +4         | JSON/JSONB operations, analysis            |\n| `text`          | 15   | 20     | +4         | Text processing + FTS5 + advanced search   |\n| `stats`         | 17   | 23     | +4         | Descriptive, inference, window functions   |\n| `vector`        | 11   | 11     | +4         | Vector storage, similarity search          |\n| `admin`         | 30   | 31     | +4         | DB maintenance, backup, virtual tables     |\n| `transactions`  | 0    | 8      | +4         | Commit, rollback, savepoints (Native only) |\n| `geo`           | 4    | 11     | +4         | Geospatial + SpatiaLite (Native only)      |\n| `introspection` | 10   | 10     | +4         | Schema mapping, FK graph, analysis         |\n| `migration`     | 6    | 6      | +4         | Schema migration tracking (opt-in)         |\n\n### Syntax Reference\n\n| Prefix   | Target   | Example         | Effect                                        |\n| -------- | -------- | --------------- | --------------------------------------------- |\n| _(none)_ | Shortcut | `starter`       | **Whitelist Mode:** Enable ONLY this shortcut |\n| _(none)_ | Group    | `core`          | **Whitelist Mode:** Enable ONLY this group    |\n| _(none)_ | Tool     | `read_query`    | **Whitelist Mode:** Enable ONLY this tool     |\n| `+`      | Group    | `+vector`       | Add tools from this group to current set      |\n| `-`      | Group    | `-admin`        | Remove tools in this group from current set   |\n| `+`      | Tool     | `+fuzzy_search` | Add one specific tool                         |\n| `-`      | Tool     | `-drop_table`   | Remove one specific tool                      |\n\n### Custom Tool Selection\n\nYou can list individual tool names (without `+` prefix) to create a fully custom whitelist — only the tools you specify will be enabled:\n\nEnable exactly 3 tools (whitelist mode):\n\n```bash\n--tool-filter \"read_query,write_query,list_tables\"\n```\n\nMix tools from different groups:\n\n```bash\n--tool-filter \"read_query,fuzzy_search,vector_search\"\n```\n\nCombine with a shortcut or group:\n\n```bash\n--tool-filter \"starter,+vector_search,+fuzzy_search\"\n```\n\nThis is useful for scripted or automated clients that need a minimal, precise set of capabilities.\n\n**Examples:**\n\n```bash\n--tool-filter \"starter\"\n--tool-filter \"core,json,text,stats\"\n--tool-filter \"starter,+stats\"\n--tool-filter \"starter,-vector\"\n```\n\n**Legacy Syntax (still supported):**\nIf you start with a negative filter (e.g., `-vector,-geo`), it assumes you want to start with _all_ tools enabled and then subtract.\n\n```bash\n--tool-filter \"-stats,-vector,-geo,-backup,-monitoring,-transactions,-window\"\n```\n\n## 🔌 SQLite Extensions\n\nSQLite supports both **built-in** extensions (compiled into better-sqlite3) and **loadable** extensions (require separate binaries).\n\n#### Built-in Extensions (work out of box)\n\n| Extension  | Purpose                             | Status           |\n| ---------- | ----------------------------------- | ---------------- |\n| **FTS5**   | Full-text search with BM25 ranking  | ✅ Always loaded |\n| **JSON1**  | JSON functions (json_extract, etc.) | ✅ Always loaded |\n| **R-Tree** | Spatial indexing for bounding boxes | ✅ Always loaded |\n\n#### Loadable Extensions (require installation)\n\n| Extension      | Purpose                   | Tools | CLI Flag       |\n| -------------- | ------------------------- | ----- | -------------- |\n| **CSV**        | CSV virtual tables        | 2     | `--csv`        |\n| **SpatiaLite** | Advanced GIS capabilities | 7     | `--spatialite` |\n\n#### Installing Extensions\n\n**CSV Extension:**\n\nDownload a precompiled binary or compile from source: https://www.sqlite.org/csv.html\n\nSet the environment variable (Linux/macOS):\n\n```bash\nexport CSV_EXTENSION_PATH=/path/to/csv.so\n```\n\nOn Windows, use `.dll`:\n\n```bash\nexport CSV_EXTENSION_PATH=/path/to/csv.dll\n```\n\nOr use the CLI flag:\n\n```bash\ndb-mcp --sqlite-native ./data.db --csv\n```\n\n**SpatiaLite Extension:**\n\nInstall the library for your platform:\n\n- **Linux (apt):** `sudo apt install libspatialite-dev`\n- **macOS (Homebrew):** `brew install libspatialite`\n- **Windows:** Download from https://www.gaia-gis.it/gaia-sins/\n\nSet the environment variable:\n\n```bash\nexport SPATIALITE_PATH=/path/to/mod_spatialite.so\n```\n\nOr use the CLI flag:\n\n```bash\ndb-mcp --sqlite-native ./data.db --spatialite\n```\n\n> **Note:** Extension binaries must match your platform and architecture. The server searches common paths automatically, or use the `CSV_EXTENSION_PATH` / `SPATIALITE_PATH` environment variables for custom locations.\n\n## 📁 Resources\n\n### Data Resources (11)\n\nMCP resources provide read-only access to database metadata:\n\n| Resource                 | URI                                 | Description                       | Min Config    |\n| ------------------------ | ----------------------------------- | --------------------------------- | ------------- |\n| `sqlite_schema`          | `sqlite://schema`                   | Full database schema              | `minimal`     |\n| `sqlite_tables`          | `sqlite://tables`                   | List all tables                   | `minimal`     |\n| `sqlite_table_schema`    | `sqlite://table/{tableName}/schema` | Schema for a specific table       | `minimal`     |\n| `sqlite_indexes`         | `sqlite://indexes`                  | All indexes in the database       | `minimal`     |\n| `sqlite_views`           | `sqlite://views`                    | All views in the database         | `core,admin`  |\n| `sqlite_health`          | `sqlite://health`                   | Database health and status        | _(read-only)_ |\n| `sqlite_meta`            | `sqlite://meta`                     | Database metadata and PRAGMAs     | `core,admin`  |\n| `sqlite_compile_options` | `sqlite://compile_options`          | SQLite compile-time build options | _(read-only)_ |\n| `sqlite_pragma`          | `sqlite://pragma`                   | Runtime PRAGMA config snapshot    | _(read-only)_ |\n| `sqlite_audit`           | `sqlite://audit`                    | Recent audit log + backup stats   | `--audit-log` |\n| `sqlite_metrics`         | `sqlite://metrics`                  | Internal server metrics           | _(read-only)_ |\n\n### Help Resources (1 + up to 10)\n\nOn-demand tool reference documentation, filtered by `--tool-filter`:\n\n| Resource                    | URI                           | Description                                           | When Registered             |\n| --------------------------- | ----------------------------- | ----------------------------------------------------- | --------------------------- |\n| `sqlite_help`               | `sqlite://help`               | Gotchas, WASM vs Native, Code Mode API                | Always                      |\n| `sqlite_help_core`          | `sqlite://help/core`          | Core CRUD and table operations reference              | When core group on          |\n| `sqlite_help_json`          | `sqlite://help/json`          | JSON/JSONB operations reference                       | When json group on          |\n| `sqlite_help_text`          | `sqlite://help/text`          | Text processing + FTS5 reference                      | When text group on          |\n| `sqlite_help_stats`         | `sqlite://help/stats`         | Statistical analysis + window functions reference     | When stats group on         |\n| `sqlite_help_vector`        | `sqlite://help/vector`        | Vector/semantic search reference                      | When vector group on        |\n| `sqlite_help_geo`           | `sqlite://help/geo`           | Geospatial + SpatiaLite reference                     | When geo group on           |\n| `sqlite_help_admin`         | `sqlite://help/admin`         | Admin, backup, virtual tables reference               | When admin group on         |\n| `sqlite_help_transactions`  | `sqlite://help/transactions`  | Transaction control reference                         | When transactions group on  |\n| `sqlite_help_introspection` | `sqlite://help/introspection` | Schema introspection, FK graph, diagnostics reference | When introspection group on |\n| `sqlite_help_migration`     | `sqlite://help/migration`     | Migration tracking, apply, rollback reference         | When migration group on     |\n\n> **Efficiency Tip:** Data resources are always **readable** regardless of tool configuration. The \"Min Config\" column shows the smallest configuration that provides tools to **act on** what the resource exposes. Help resources are served on-demand — agents read them only when working with a specific tool group.\n\n## 💬 Prompts (10)\n\nMCP prompts provide AI-assisted database workflows:\n\n| Prompt                          | Description                                      |\n| ------------------------------- | ------------------------------------------------ |\n| `sqlite_explain_schema`         | Explain database structure and relationships     |\n| `sqlite_query_builder`          | Help construct SQL queries for common operations |\n| `sqlite_data_analysis`          | Analyze data patterns and provide insights       |\n| `sqlite_optimization`           | Analyze and suggest database optimizations       |\n| `sqlite_migration`              | Help create database migration scripts           |\n| `sqlite_debug_query`            | Debug SQL queries that aren't working            |\n| `sqlite_documentation`          | Generate documentation for the database schema   |\n| `sqlite_summarize_table`        | Intelligent table analysis and summary           |\n| `sqlite_hybrid_search_workflow` | Hybrid FTS5 + vector search workflow             |\n| `sqlite_demo`                   | Interactive demo of MCP capabilities             |\n\n## 🔧 Configuration\n\n### Environment Variables\n\n| Variable                    | Default     | Description                                                                    |\n| --------------------------- | ----------- | ------------------------------------------------------------------------------ |\n| `MCP_HOST`                  | `127.0.0.1` | Host/IP to bind to (`0.0.0.0` in Docker) (CLI: `--server-host`)                |\n| `SQLITE_DATABASE`           | —           | SQLite database path (CLI: `--sqlite` / `--sqlite-native`)                     |\n| `DB_ENCRYPTION_KEY`         | —           | SQLCipher encryption key (Native only) (CLI: `--encryption-key`)               |\n| `DB_MCP_TOOL_FILTER`        | —           | Tool filter string (CLI: `--tool-filter`)                                      |\n| `METRICS_EXPORT`            | —           | Export metrics at HTTP /metrics (e.g., `prometheus`) (CLI: `--metrics-export`) |\n| `OAUTH_ENABLED`             | `false`     | Enable OAuth 2.1 (CLI: `--oauth-enabled`)                                      |\n| `OAUTH_ISSUER`              | —           | Authorization server URL (CLI: `--oauth-issuer`)                               |\n| `OAUTH_AUDIENCE`            | —           | Expected token audience (CLI: `--oauth-audience`)                              |\n| `OAUTH_JWKS_URI`            | —           | JWKS URI, auto-discovered if omitted (CLI: `--oauth-jwks-uri`)                 |\n| `OAUTH_CLOCK_TOLERANCE`     | `60`        | Clock tolerance in seconds (CLI: `--oauth-clock-tolerance`)                    |\n| `MCP_ENABLE_HSTS`           | `false`     | Enable HSTS header (CLI: `--enable-hsts`)                                      |\n| `NO_AUTH_ENFORCEMENT`       | `false`     | Explicitly bypass auth enforcement for HTTP (CLI: `--no-auth-enforcement`)     |\n| `LOG_LEVEL`                 | `info`      | Log verbosity: `debug`, `info`, `warning`, `error`                             |\n| `METADATA_CACHE_TTL_MS`     | `5000`      | Schema cache TTL in ms (auto-invalidated on DDL operations)                    |\n| `CODEMODE_ISOLATION`        | `isolate`   | Code Mode sandbox: `isolate` (isolated-vm native) or `worker`                  |\n| `CODE_MODE_MAX_RESULT_SIZE` | `102400`    | Maximum Code Mode result payload in bytes (default 100KB, cap 50MB)            |\n| `MCP_RATE_LIMIT_MAX`        | `100`       | Max requests/minute per IP (HTTP transport)                                    |\n| `CSV_EXTENSION_PATH`        | —           | Custom path to CSV extension binary (native only)                              |\n| `SPATIALITE_PATH`           | —           | Custom path to SpatiaLite extension binary (native only)                       |\n| `ALLOWED_IO_ROOTS`          | —           | JSON array or comma-separated list of absolute paths allowed for IO operations |\n| `MCP_AUTH_TOKEN`            | —           | Simple bearer token for HTTP auth (CLI: `--auth-token`)                        |\n| `AUDIT_LOG`                 | —           | Audit log file path, or `stderr` (CLI: `--audit-log`)                          |\n| `AUDIT_REDACT`              | `true`      | Redact tool arguments from audit entries (CLI: `--audit-no-redact` to disable) |\n| `AUDIT_READS`               | `false`     | Also log read-scoped tool invocations (CLI: `--audit-reads`)                   |\n| `AUDIT_BACKUP`              | `false`     | Enable pre-mutation DDL snapshots (CLI: `--audit-backup`)                      |\n| `AUDIT_BACKUP_DATA`         | `false`     | Include sample data rows in snapshots (CLI: `--audit-backup-data`)             |\n\n> **Tip:** Lower `METADATA_CACHE_TTL_MS` for development (e.g., `1000`), or increase it for production with stable schemas (e.g., `60000` = 1 min). Schema cache is automatically invalidated on DDL operations (CREATE/ALTER/DROP).\n\n### CLI Reference\n\n```\ndb-mcp [options]\n\nTransport:    --transport <stdio|http|sse>  --port <N>  --server-host <host>  --stateless\nAuth:         --oauth-enabled --oauth-issuer <url> --oauth-audience <aud>\nDatabase:     --sqlite <path>  |  --sqlite-native <path>  [--encryption-key <key>]\nExtensions:   --csv  --spatialite                         (native only)\nSecurity:     --allowed-io-roots <paths>\nAudit:        --audit-log <path>  --audit-no-redact  --audit-reads  --audit-backup  --audit-backup-data\nServer:       --name <name>  --version <ver>  --metrics-export <type>  --tool-filter <filter>\n```\n\n> CLI flags override environment variables. Run `node dist/cli.js --help` for full details.\n\n## 📚 MCP Client Configuration\n\nAdd to your `~/.cursor/mcp.json`, Claude Desktop config, or equivalent:\n\n```json\n{\n  \"mcpServers\": {\n    \"db-mcp-sqlite\": {\n      \"command\": \"node\",\n      \"args\": [\n        \"C:/path/to/db-mcp/dist/cli.js\",\n        \"--transport\",\n        \"stdio\",\n        \"--sqlite-native\",\n        \"C:/path/to/your/database.db\",\n        \"--tool-filter\",\n        \"codemode\"\n      ]\n    }\n  }\n}\n```\n\n> [!TIP]\n> **Switching backends:** The config above uses the **Native** backend (better-sqlite3, 181 MCP tools). To use the **WASM** backend (sql.js, 154 MCP tools, zero native dependencies), change `--sqlite-native` to `--sqlite` in the args array. See the [Backend Options table in DOCKER_README](DOCKER_README.md#backend-options) for feature differences.\n\n**Variants** (modify the `args` array above):\n\n| Variant                | Change                                                                                                                               |\n| ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |\n| **WASM backend**       | Replace `--sqlite-native` with `--sqlite`                                                                                            |\n| **In-memory database** | Replace the database path with `:memory:`                                                                                            |\n| **Starter preset**     | Replace `\"codemode\"` with `\"starter\"` for individual tool calls                                                                      |\n| **CSV extension**      | Add `\"--csv\"` before `\"--tool-filter\"` (native only)                                                                                 |\n| **SpatiaLite**         | Add `\"--spatialite\"` and set `env: { \"SPATIALITE_PATH\": \"/path/to/mod_spatialite\" }` (native only)                                   |\n| **Linux/macOS**        | Use forward-slash Unix paths (e.g., `/path/to/db-mcp/dist/cli.js`)                                                                   |\n| **Docker**             | Replace `\"command\": \"node\"` with `\"command\": \"docker\"` and wrap args in `run -i --rm -v ./data:/app/data writenotenow/db-mcp:latest` |\n\n> See [Tool Filtering](#️-tool-filtering) to customize which tools are exposed.\n\n## 🌐 HTTP/SSE Transport (Remote Access)\n\nFor remote access, web-based clients, or HTTP-compatible MCP hosts, use the HTTP transport:\n\n```bash\nnode dist/cli.js \\\n  --transport http \\\n  --port 3000 \\\n  --sqlite-native ./database.db \\\n  --allowed-io-roots $(pwd)\n```\n\n**Docker:**\n\n```bash\ndocker run --rm -p 3000:3000 \\\n  -v ./data:/app/data \\\n  writenotenow/db-mcp:latest \\\n  --transport http --port 3000 \\\n  --sqlite-native /app/data/database.db \\\n  --allowed-io-roots /app/data\n```\n\nThe server supports **two MCP transport protocols simultaneously**, enabling both modern and legacy clients to connect:\n\n### Streamable HTTP (Recommended)\n\nModern protocol (MCP 2025-03-26) — single endpoint, session-based:\n\n| Method   | Endpoint | Purpose                                          |\n| -------- | -------- | ------------------------------------------------ |\n| `POST`   | `/mcp`   | JSON-RPC requests (initialize, tools/list, etc.) |\n| `GET`    | `/mcp`   | SSE stream for server notifications              |\n| `DELETE` | `/mcp`   | Session termination                              |\n\nSessions are managed via the `Mcp-Session-Id` header.\n\n### Stateless Mode\n\nFor serverless/stateless deployments where sessions are not needed:\n\n```bash\nnode dist/cli.js --transport http --port 3000 --stateless --sqlite-native ./database.db --allowed-io-roots $(pwd)\n```\n\nIn stateless mode: `GET /mcp` returns 405, `DELETE /mcp` returns 204, `/sse` and `/messages` return 404. Each `POST /mcp` creates a fresh transport.\n\n### Legacy SSE (Backward Compatibility)\n\nLegacy protocol (MCP 2024-11-05) — for clients like Python `mcp.client.sse`:\n\n| Method | Endpoint                   | Purpose                                                       |\n| ------ | -------------------------- | ------------------------------------------------------------- |\n| `GET`  | `/sse`                     | Opens SSE stream, returns `/messages?sessionId=<id>` endpoint |\n| `POST` | `/messages?sessionId=<id>` | Send JSON-RPC messages to the session                         |\n\n### Utility Endpoints\n\n| Method | Endpoint  | Purpose                                                                |\n| ------ | --------- | ---------------------------------------------------------------------- |\n| `GET`  | `/health` | Health check (bypasses rate limiting, always available for monitoring) |\n\n## 🔐 Authentication\n\ndb-mcp secures the HTTP transport using strict OAuth 2.1 authentication:\n\n### OAuth 2.1 (Enterprise)\n\nFull OAuth 2.1 with RFC 9728/8414 compliance for production multi-tenant deployments:\n\n```bash\nnode dist/cli.js \\\n  --transport http \\\n  --port 3000 \\\n  --sqlite-native ./database.db \\\n  --allowed-io-roots $(pwd) \\\n  --oauth-enabled \\\n  --oauth-issuer http://localhost:8080/realms/db-mcp \\\n  --oauth-audience db-mcp-server\n```\n\n> **Additional flags:** `--oauth-jwks-uri <url>` (auto-discovered if omitted), `--oauth-clock-tolerance <seconds>` (default: 60).\n\n### OAuth Scopes\n\nAccess control is managed through OAuth scopes:\n\n| Scope   | Description                            |\n| ------- | -------------------------------------- |\n| `full`  | Unrestricted access to all operations  |\n| `read`  | Read-only access to all databases      |\n| `write` | Read and write access to all databases |\n| `admin` | Full administrative access             |\n\n### RFC Compliance\n\nThis implementation follows:\n\n- **RFC 9728** — OAuth 2.1 Protected Resource Metadata\n- **RFC 8414** — OAuth 2.1 Authorization Server Metadata\n- **RFC 7591** — OAuth 2.1 Dynamic Client Registration\n\nThe server exposes metadata at `/.well-known/oauth-protected-resource`.\n\n> **Note for Keycloak users:** Add an **Audience mapper** to your client (Client → Client scopes → dedicated scope → Add mapper → Audience) to include the correct `aud` claim in tokens.\n\n> [!NOTE]\n> **Per-tool scope enforcement:** Scopes are enforced at the tool level — each tool group maps to a required scope (`read`, `write`, or `admin`). Unknown or unmapped tools default to `admin` (fail-closed). When OAuth is enabled, every tool invocation checks the calling token's scopes before execution. When OAuth is not configured, scope checks are skipped entirely.\n\n> [!TIP]\n> **Audit identity integration:** When OAuth is enabled alongside audit logging (`--audit-log`), audit entries for write/admin tools automatically capture the authenticated user (`claims.sub`) and granted scopes. This provides a complete forensic trail linking every mutation to a specific identity. Without OAuth, these fields are `null`/`[]`.\n\n> [!WARNING]\n> **HTTP without authentication:** When using `--transport http` without enabling OAuth, all clients have full unrestricted access. Always enable authentication for production HTTP deployments. See [SECURITY.md](SECURITY.md) for details.\n\n## 🔐 Encryption at Rest (Native Only)\n\ndb-mcp supports transparent database encryption using SQLCipher via the `better-sqlite3-multiple-ciphers` driver. When encryption is enabled, the server automatically encrypts both your target database (if newly created) and the sidecar `SystemDb` audit log, ensuring your schema, queries, and results are protected at rest.\n\n**Important WASM Limitation**: The WASM backend (`sql.js`) **does not** support encryption. If you supply an encryption key to the WASM backend, it will gracefully ignore it for the target database. However, this can cause conflicts if both a Native and WASM backend share the same `--audit-log` file (since the Native backend will encrypt the shared audit log, causing the WASM backend to crash when reading it). To avoid this in dual-backend setups, assign a separate audit log (e.g., `--audit-log mcp-audit-wasm.db`) for your WASM instance.\n\n**Configuring the Key**:\nYou can provide the key via the `--encryption-key` CLI flag or the `DB_ENCRYPTION_KEY` environment variable.\n\n1. **Strong Passphrase**: A standard string. SQLCipher will automatically use PBKDF2 key derivation.\n   ```bash\n   DB_ENCRYPTION_KEY=\"your-strong-passphrase-here\"\n   ```\n2. **Raw Hex Key (Best Performance)**: To skip PBKDF2 derivation overhead, provide an exact 256-bit raw hex key prefixed with `x` and wrapped in single quotes:\n   ```bash\n   DB_ENCRYPTION_KEY=\"x'2DD29CA851E7B56E4697B0E1F08507293D761A05CE4D1B628663F411A8086D99'\"\n   ```\n\n> [!WARNING]\n> **Audit Log Compatibility**: The `DB_ENCRYPTION_KEY` environment variable applies globally and will cause the internal `SystemDb` to attempt to decrypt your audit log (`--audit-log`). If you have an existing unencrypted audit log, the server will fail to start with `file is not a database`. To encrypt ONLY your target database (leaving the audit log unencrypted), use the `--encryption-key` CLI flag instead of the global environment variable.\n\n## 📊 Benchmarks\n\nPerformance benchmarks measure framework overhead on critical hot paths using [Vitest bench](https://vitest.dev/guide/features.html#benchmarking) (tinybench). The suite validates that framework plumbing stays negligible relative to actual database I/O:\n\n- **Tool dispatch:** 6–14M ops/sec — Map-based lookup is effectively zero-cost\n- **Auth scope checks:** 4–8M ops/sec — OAuth middleware adds no measurable latency\n- **Identifier validation:** 4–7M ops/sec — SQL sanitization is near-instant\n- **Schema cache hits:** 3–6M ops/sec — metadata lookups avoid redundant queries\n- **Debug log (filtered):** 5–11M ops/sec — disabled log levels are true no-ops\n- **Code Mode security:** ~0.2–1.3M validations/sec for typical code, blocked patterns rejected in 1-2 µs\n- **Sandbox execution:** ~0.5–4.9K executions/sec — trivial code round-trips through V8 isolate in 0.2-1.5 ms\n\n```bash\npnpm run bench            # Run all benchmarks\npnpm run bench:verbose    # Verbose mode with detailed timings\n```\n\n| Benchmark             | What It Measures                                                        |\n| --------------------- | ----------------------------------------------------------------------- |\n| Handler Dispatch      | Tool lookup, error construction, progress notification overhead         |\n| Utilities             | Identifier sanitization, WHERE clause validation, SQL validation        |\n| Tool Filtering        | Filter parsing, group lookups, meta-group catalog generation            |\n| Schema Parsing        | Zod schema validation for simple/complex/large payloads + failure paths |\n| Logger & Sanitization | Log call overhead, message sanitization, sensitive data redaction       |\n| Transport & Auth      | Token extraction, scope checking, error formatting, rate limiting       |\n| Code Mode             | Sandbox creation, pool lifecycle, security validation, execution        |\n| Database Operations   | PRAGMA ops, table metadata, query result processing, schema caching     |\n| Resource & Prompts    | URI matching, content assembly, prompt generation, tool indexing        |\n\n---\n\n## Contributing\n\nContributions are welcome! Please read our [Contributing Guidelines](CONTRIBUTING.md) before submitting a pull request.\n\n## Security\n\nFor security concerns, please see our [Security Policy](SECURITY.md).\n\n> **⚠️ Never commit credentials** - Store secrets in `.env` (gitignored)\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n\n## Code of Conduct\n\nPlease read our [Code of Conduct](CODE_OF_CONDUCT.md) before participating in this project.\n",
  "bytes": 44456,
  "sha": "c1b9e179586a54d9b2cf15538c5d0320053b4afea6ee44917f468956a9eb9f4c",
  "repo_slug": "neverinfamous/db-mcp",
  "fonte": "repo",
  "truncated": false,
  "api": "https://agentalog.com/api/listings/mcp_io_github_neverinfamous_db_mcp_59652328/readme"
}