@dbx-app/mcp-server 0.4.14 → 0.4.16

package/README.md

@@ -7,7 +7,7 @@ MCP server for [DBX](https://github.com/t8y2/dbx) — lets AI agents (Claude Cod
 ## Features
 
 - **Zero config** — Automatically reads your DBX connections (including passwords from system keyring)
-- **8 tools** — List/add/remove connections, list tables, describe table, get schema context, execute SQL, open table in DBX UI
+- **9 tools** — List/add/remove connections, list tables, describe table, get schema context, execute SQL, execute Redis commands, open table in DBX UI
 - **Connection pooling** — Reuses database connections across queries
 - **Direct execution** — PostgreSQL, MySQL, SQLite, and compatible databases (Doris, StarRocks, etc.) can run without opening DBX
 - **Writes enabled by default** — regular `INSERT` / `UPDATE` / `DELETE` statements work out of the box, while dangerous SQL stays blocked unless explicitly enabled
@@ -79,16 +79,17 @@ See the [DBX CLI README](../cli/README.md) for command details.
 
 ## Tools
 
-| Tool                     | Description                                          |
-| ------------------------ | ---------------------------------------------------- |
-| `dbx_list_connections`   | List all database connections configured in DBX      |
-| `dbx_add_connection`     | Add a new database connection                        |
-| `dbx_remove_connection`  | Remove a database connection                         |
-| `dbx_list_tables`        | List tables and views for a connection               |
-| `dbx_describe_table`     | Get column definitions for a table                   |
-| `dbx_get_schema_context` | Get compact table and column context for writing SQL |
-| `dbx_execute_query`      | Execute a SQL query (max 100 rows)                   |
-| `dbx_open_table`         | Open a table in DBX desktop app UI                   |
+| Tool                        | Description                                          |
+| --------------------------- | ---------------------------------------------------- |
+| `dbx_list_connections`      | List all database connections configured in DBX      |
+| `dbx_add_connection`        | Add a new database connection                        |
+| `dbx_remove_connection`     | Remove a database connection                         |
+| `dbx_list_tables`           | List tables and views for a connection               |
+| `dbx_describe_table`        | Get column definitions for a table                   |
+| `dbx_get_schema_context`    | Get compact table and column context for writing SQL |
+| `dbx_execute_query`         | Execute a SQL query (max 100 rows)                   |
+| `dbx_execute_redis_command` | Execute a Redis command on a Redis connection        |
+| `dbx_open_table`            | Open a table in DBX desktop app UI                   |
 
 ## SQL Safety
 
@@ -106,6 +107,8 @@ Dangerous statements such as `DROP`, `TRUNCATE`, and `ALTER` remain blocked unle
 DBX_MCP_ALLOW_DANGEROUS_SQL=1
 ```
 
+Redis connections use `dbx_execute_redis_command` instead of `dbx_execute_query`. Redis write commands honor `DBX_MCP_ALLOW_WRITES`; dangerous Redis commands such as `KEYS`, `FLUSHALL`, and `EVAL` require `DBX_MCP_ALLOW_DANGEROUS_SQL=1`.
+
 ## How It Works
 
 ```
@@ -124,7 +127,7 @@ The MCP server reads your database connections from DBX's SQLite database:
 
 The `dbx_open_table` tool communicates with the running DBX app to open tables directly in the UI. This requires DBX to be running. If DBX is not running, the tool will return an error message.
 
-PostgreSQL, MySQL, SQLite, Doris, StarRocks, and Redshift queries run directly from the MCP server. Other database types still use the DBX desktop bridge for query, table, and column operations unless `DBX_WEB_URL` is configured.
+PostgreSQL, MySQL, SQLite, Doris, StarRocks, and Redshift queries run directly from the MCP server. Redis standalone command execution also runs directly. Other database types, plus Redis Sentinel/Cluster or SSH-backed Redis connections, still use the DBX desktop bridge unless `DBX_WEB_URL` is configured.
 
 ## Requirements
 
@@ -144,7 +147,7 @@ Apache-2.0
 ### 特性
 
 - **零配置** — 自动读取 DBX 的连接配置
-- **8 个工具** — 列出/添加/删除连接、列出表、查看表结构、获取 Schema 上下文、执行 SQL、在 DBX 中打开表
+- **9 个工具** — 列出/添加/删除连接、列出表、查看表结构、获取 Schema 上下文、执行 SQL、执行 Redis 命令、在 DBX 中打开表
 - **连接池** — 跨查询复用数据库连接
 - **直接执行** — PostgreSQL、MySQL、SQLite 及兼容数据库（Doris、StarRocks 等）无需打开 DBX 即可查询
 - **默认允许常规写入** — `INSERT` / `UPDATE` / `DELETE` 可直接执行，危险语句仍需显式开启
@@ -202,16 +205,17 @@ dbx query local "select 1" --json
 
 ### 工具列表
 
-| 工具                     | 说明                                  |
-| ------------------------ | ------------------------------------- |
-| `dbx_list_connections`   | 列出 DBX 中所有已配置的数据库连接     |
-| `dbx_add_connection`     | 添加新的数据库连接                    |
-| `dbx_remove_connection`  | 删除数据库连接                        |
-| `dbx_list_tables`        | 列出指定连接的表和视图                |
-| `dbx_describe_table`     | 获取表的列定义                        |
-| `dbx_get_schema_context` | 获取适合 AI 写 SQL 的紧凑表结构上下文 |
-| `dbx_execute_query`      | 执行 SQL 查询（最多返回 100 行）      |
-| `dbx_open_table`         | 在 DBX 桌面端打开指定表               |
+| 工具                        | 说明                                  |
+| --------------------------- | ------------------------------------- |
+| `dbx_list_connections`      | 列出 DBX 中所有已配置的数据库连接     |
+| `dbx_add_connection`        | 添加新的数据库连接                    |
+| `dbx_remove_connection`     | 删除数据库连接                        |
+| `dbx_list_tables`           | 列出指定连接的表和视图                |
+| `dbx_describe_table`        | 获取表的列定义                        |
+| `dbx_get_schema_context`    | 获取适合 AI 写 SQL 的紧凑表结构上下文 |
+| `dbx_execute_query`         | 执行 SQL 查询（最多返回 100 行）      |
+| `dbx_execute_redis_command` | 在 Redis 连接上执行 Redis 命令        |
+| `dbx_open_table`            | 在 DBX 桌面端打开指定表               |
 
 ### SQL 安全
 
@@ -229,6 +233,8 @@ DBX_MCP_ALLOW_WRITES=0
 DBX_MCP_ALLOW_DANGEROUS_SQL=1
 ```
 
+Redis 连接使用 `dbx_execute_redis_command`，不通过 `dbx_execute_query` 执行。Redis 写命令遵循 `DBX_MCP_ALLOW_WRITES`；`KEYS`、`FLUSHALL`、`EVAL` 等危险 Redis 命令需要设置 `DBX_MCP_ALLOW_DANGEROUS_SQL=1`。
+
 ### 工作原理
 
 MCP Server 从 DBX 的 SQLite 数据库读取连接信息：
@@ -241,7 +247,7 @@ MCP Server 从 DBX 的 SQLite 数据库读取连接信息：
 
 `dbx_open_table` 工具通过本地 HTTP 接口与运行中的 DBX 应用通信，直接在 UI 中打开表。需要 DBX 正在运行。
 
-PostgreSQL、MySQL、SQLite、Doris、StarRocks、Redshift 查询可由 MCP Server 直接执行。其他数据库类型的查询、表列表、字段读取仍会走 DBX 桌面端 bridge，除非配置了 `DBX_WEB_URL` 使用 Web 后端。
+PostgreSQL、MySQL、SQLite、Doris、StarRocks、Redshift 查询可由 MCP Server 直接执行。Redis standalone 命令执行也会直接连接。其他数据库类型，以及 Redis Sentinel/Cluster 或 SSH Redis 连接，仍会走 DBX 桌面端 bridge，除非配置了 `DBX_WEB_URL` 使用 Web 后端。
 
 ### 系统要求
 

package/dist/index.d.ts

@@ -2,7 +2,7 @@
 import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import { type Backend } from "@dbx-app/node-core";
 export declare const DBX_MCP_PACKAGE_VERSION: string;
-export declare const DBX_CONNECTION_TYPE_DESCRIPTION = "Database type: postgres, mysql, sqlite, rqlite, redis, duckdb, clickhouse, sqlserver, mongodb, oracle, elasticsearch, etcd, doris, starrocks, manticoresearch, milvus, qdrant, weaviate, redshift, dameng, kingbase, highgo, vastbase, goldendb, databend, gaussdb, kwdb, yashandb, databricks, saphana, teradata, vertica, firebird, exasol, opengauss, oceanbase-oracle, questdb, gbase, h2, snowflake, trino, prestosql, hive, db2, informix, influxdb, iris, neo4j, cassandra, bigquery, kylin, sundb, tdengine, iotdb, xugu, zookeeper, jdbc, access, mq";
+export declare const DBX_CONNECTION_TYPE_DESCRIPTION = "Database type: postgres, mysql, sqlite, rqlite, redis, duckdb, clickhouse, sqlserver, mongodb, oracle, elasticsearch, etcd, doris, starrocks, manticoresearch, milvus, qdrant, weaviate, chromadb, redshift, dameng, kingbase, highgo, vastbase, goldendb, databend, gaussdb, kwdb, yashandb, databricks, saphana, teradata, vertica, firebird, exasol, opengauss, oceanbase-oracle, questdb, gbase, h2, snowflake, trino, prestosql, hive, db2, informix, influxdb, iris, neo4j, cassandra, bigquery, kylin, sundb, tdengine, iotdb, xugu, zookeeper, jdbc, access, mq";
 export declare function createDbxMcpServer(backend: Backend, options?: {
     isWebMode?: boolean;
 }): McpServer;

package/dist/index.js

@@ -3,7 +3,7 @@ import { McpServer } from "@modelcontextprotocol/sdk/server/mcp.js";
 import { StdioServerTransport } from "@modelcontextprotocol/sdk/server/stdio.js";
 import { createRequire } from "node:module";
 import { z } from "zod";
-import { buildSchemaContext, createBackend, evaluateMongoAggregateSafety, evaluateSqlSafety, formatCell, formatSchemaContext, isMainModule, mdTable, notifyReload, parseMongoAggregateCommand, postBridge, sqlSafetyFromEnv, splitSqlStatements, } from "@dbx-app/node-core";
+import { buildSchemaContext, createBackend, evaluateRedisCommandSafety, evaluateMongoAggregateSafety, evaluateSqlSafety, formatCell, formatSchemaContext, isMainModule, mdTable, notifyReload, parseMongoAggregateCommand, postBridge, sqlSafetyFromEnv, splitSqlStatements, } from "@dbx-app/node-core";
 const require = createRequire(import.meta.url);
 const packageJson = require("../package.json");
 export const DBX_MCP_PACKAGE_VERSION = packageJson.version ?? "0.0.0";
@@ -23,7 +23,25 @@ function formatQueryToolResult(result, title) {
     const rows = result.rows.map((r) => result.columns.map((c) => formatCell(r[c])));
     return text(`${prefix}${mdTable(result.columns, rows)}\n\n${result.row_count} row(s)`);
 }
-export const DBX_CONNECTION_TYPE_DESCRIPTION = "Database type: postgres, mysql, sqlite, rqlite, redis, duckdb, clickhouse, sqlserver, mongodb, oracle, elasticsearch, etcd, doris, starrocks, manticoresearch, milvus, qdrant, weaviate, redshift, dameng, kingbase, highgo, vastbase, goldendb, databend, gaussdb, kwdb, yashandb, databricks, saphana, teradata, vertica, firebird, exasol, opengauss, oceanbase-oracle, questdb, gbase, h2, snowflake, trino, prestosql, hive, db2, informix, influxdb, iris, neo4j, cassandra, bigquery, kylin, sundb, tdengine, iotdb, xugu, zookeeper, jdbc, access, mq";
+function redisDbFromValue(value) {
+    const trimmed = value?.trim();
+    if (!trimmed)
+        return undefined;
+    const db = Number(trimmed);
+    return Number.isInteger(db) && db >= 0 ? db : undefined;
+}
+function defaultRedisDb(config, scope, db) {
+    return db ?? redisDbFromValue(scope.database) ?? redisDbFromValue(config.database) ?? 0;
+}
+function formatRedisCommandValue(value) {
+    if (typeof value === "string")
+        return value;
+    return JSON.stringify(value, null, 2) ?? String(value);
+}
+function formatRedisCommandToolResult(result) {
+    return text(`Command: ${result.command}\nSafety: ${result.safety}\n\n${formatRedisCommandValue(result.value)}`);
+}
+export const DBX_CONNECTION_TYPE_DESCRIPTION = "Database type: postgres, mysql, sqlite, rqlite, redis, duckdb, clickhouse, sqlserver, mongodb, oracle, elasticsearch, etcd, doris, starrocks, manticoresearch, milvus, qdrant, weaviate, chromadb, redshift, dameng, kingbase, highgo, vastbase, goldendb, databend, gaussdb, kwdb, yashandb, databricks, saphana, teradata, vertica, firebird, exasol, opengauss, oceanbase-oracle, questdb, gbase, h2, snowflake, trino, prestosql, hive, db2, informix, influxdb, iris, neo4j, cassandra, bigquery, kylin, sundb, tdengine, iotdb, xugu, zookeeper, jdbc, access, mq";
 const FILE_CAPABLE_CONNECTION_TYPES = new Set(["sqlite", "duckdb", "access", "h2"]);
 function scopedValue(value) {
     const trimmed = value?.trim();
@@ -116,6 +134,9 @@ export function createDbxMcpServer(backend, options = {}) {
         if (error)
             return error;
         const scopedConfig = config;
+        if (scopedConfig.db_type === "redis") {
+            return toolError("REDIS_COMMAND_REQUIRED", "Redis connections do not accept SQL through dbx_execute_query. Use dbx_execute_redis_command with a Redis command such as GET key or INFO.");
+        }
         if (scopedConfig.db_type !== "mongodb") {
             const safety = evaluateSqlSafety(sql, { ...sqlSafetyFromEnv(), allowMultipleStatements: true });
             if (!safety.allowed)
@@ -138,6 +159,35 @@ export function createDbxMcpServer(backend, options = {}) {
             return toolError("QUERY_ERROR", msg);
         }
     });
+    server.tool("dbx_execute_redis_command", "Execute a Redis command on a Redis connection", {
+        connection_name: z.string().optional().describe("Name of the DBX Redis connection"),
+        db: z.number().int().min(0).optional().describe("Redis logical database number (default: scoped/default database or 0)"),
+        command: z.string().describe("Redis command to execute, for example: GET mykey, INFO, or DBSIZE"),
+    }, async ({ connection_name, db, command }) => {
+        const { config, error } = await resolveConnection(backend, scope, connection_name);
+        if (error)
+            return error;
+        const scopedConfig = config;
+        if (scopedConfig.db_type !== "redis") {
+            return toolError("INVALID_CONNECTION_TYPE", `Connection "${scopedConfig.name}" is ${scopedConfig.db_type}, not Redis.`);
+        }
+        if (!backend.executeRedisCommand) {
+            return toolError("UNSUPPORTED_BACKEND", "This DBX backend does not support Redis command execution.");
+        }
+        const safety = evaluateRedisCommandSafety(command, sqlSafetyFromEnv());
+        if (!safety.allowed)
+            return toolError("REDIS_COMMAND_BLOCKED", safety.reason ?? "Redis command blocked.");
+        try {
+            const result = await backend.executeRedisCommand(scopedConfig, defaultRedisDb(scopedConfig, scope, db), command, {
+                skipSafetyCheck: safety.skipSafetyCheck,
+            });
+            return formatRedisCommandToolResult(result);
+        }
+        catch (e) {
+            const msg = e instanceof Error ? e.message : String(e);
+            return toolError("REDIS_COMMAND_ERROR", msg);
+        }
+    });
     server.tool("dbx_get_schema_context", "Get compact table and column context for writing SQL", {
         connection_name: z.string().optional().describe("Name of the DBX connection"),
         database: z.string().optional().describe("Database name"),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dbx-app/mcp-server",
-  "version": "0.4.14",
+  "version": "0.4.16",
   "description": "MCP server for DBX — query databases from Claude Code, Cursor, and other AI agents",
   "keywords": [
     "ai-agent",
@@ -30,7 +30,7 @@
   "dependencies": {
     "@modelcontextprotocol/sdk": "^1.12.1",
     "zod": "^3.25.20",
-    "@dbx-app/node-core": "^0.4.14"
+    "@dbx-app/node-core": "^0.4.16"
   },
   "devDependencies": {
     "@types/node": "^22.15.21",

package/server.json

@@ -6,12 +6,12 @@
     "url": "https://github.com/t8y2/dbx",
     "source": "github"
   },
-  "version": "0.4.14",
+  "version": "0.4.16",
   "packages": [
     {
       "registryType": "npm",
       "identifier": "@dbx-app/mcp-server",
-      "version": "0.4.14",
+      "version": "0.4.16",
       "transport": {
         "type": "stdio"
       }