@neverinfamous/mysql-mcp 2.3.0 → 3.0.0

package/src/adapters/mysql/tools/security/encryption.ts

@@ -4,13 +4,30 @@
  * Tools for SSL/TLS monitoring, encryption status, and password validation.
  */
 
-import { z } from "zod";
+import { z, ZodError } from "zod";
 import type { MySQLAdapter } from "../../MySQLAdapter.js";
 import type {
   ToolDefinition,
   RequestContext,
 } from "../../../../types/index.js";
 
+// =============================================================================
+// Helpers
+// =============================================================================
+
+/** Extract human-readable messages from a ZodError instead of raw JSON array */
+function formatZodError(error: ZodError): string {
+  return error.issues.map((i) => i.message).join("; ");
+}
+
+/** Strip verbose adapter prefixes from error messages */
+function stripErrorPrefix(msg: string): string {
+  return msg
+    .replace(/^Query failed:\s*/i, "")
+    .replace(/^Execute failed:\s*/i, "")
+    .trim();
+}
+
 // =============================================================================
 // Zod Schemas
 // =============================================================================
@@ -41,73 +58,69 @@ export function createSecuritySSLStatusTool(
       idempotentHint: true,
     },
     handler: async (_params: unknown, _context: RequestContext) => {
-      // Get SSL status
-      const statusResult = await adapter.executeQuery(
-        "SHOW STATUS LIKE 'Ssl%'",
-      );
-
-      const status: Record<string, unknown> = Object.fromEntries(
-        (statusResult.rows ?? []).map((r) => {
-          const record = r;
-          const varName =
-            typeof record["Variable_name"] === "string"
-              ? record["Variable_name"]
-              : "";
-          return [varName, record["Value"]];
-        }),
-      );
-
-      // Get SSL variables
-      const varsResult = await adapter.executeQuery(
-        "SHOW VARIABLES LIKE '%ssl%'",
-      );
-
-      const variables: Record<string, unknown> = Object.fromEntries(
-        (varsResult.rows ?? []).map((r) => {
-          const record = r;
-          const varName =
-            typeof record["Variable_name"] === "string"
-              ? record["Variable_name"]
-              : "";
-          return [varName, record["Value"]];
-        }),
-      );
+      try {
+        // Get SSL status
+        const statusResult = await adapter.executeQuery(
+          "SHOW STATUS LIKE 'Ssl%'",
+        );
 
-      // Check current connection
-      // We use raw status/variables now, but @@ssl_cipher is still valid
-      // const connResult = await adapter.executeQuery("SELECT @@ssl_cipher as cipher"); // Removing unused query for now as we get cipher from status
+        const status: Record<string, unknown> = Object.fromEntries(
+          (statusResult.rows ?? []).map((r) => {
+            const record = r;
+            const varName =
+              typeof record["Variable_name"] === "string"
+                ? record["Variable_name"]
+                : "";
+            return [varName, record["Value"]];
+          }),
+        );
 
-      // Actually, wait, status['Ssl_cipher'] gives the cipher.
-      // But let's check if we need @@ssl_cipher.
-      // The original code used: sslEnabled: str(status['Ssl_cipher']) !== ''
-      // So we don't strictly need @@ssl_cipher if Ssl_cipher status is reliable.
-      // Let's just remove the unused query entirely.
+        // Get SSL variables
+        const varsResult = await adapter.executeQuery(
+          "SHOW VARIABLES LIKE '%ssl%'",
+        );
 
-      // const connRow = connResult.rows?.[0]; // deleted
+        const variables: Record<string, unknown> = Object.fromEntries(
+          (varsResult.rows ?? []).map((r) => {
+            const record = r;
+            const varName =
+              typeof record["Variable_name"] === "string"
+                ? record["Variable_name"]
+                : "";
+            return [varName, record["Value"]];
+          }),
+        );
 
-      // Helper to safely extract string values
-      const str = (val: unknown, defaultVal = ""): string =>
-        typeof val === "string" ? val : defaultVal;
+        // Helper to safely extract string values
+        const str = (val: unknown, defaultVal = ""): string =>
+          typeof val === "string" && val !== "" ? val : defaultVal;
 
-      return {
-        sslEnabled: str(status["Ssl_cipher"]) !== "",
-        currentCipher: str(status["Ssl_cipher"], "None"),
-        sslVersion: str(status["Ssl_version"], "N/A"),
-        serverCertVerification: false, // Unknown in recent versions via variables
-        configuration: {
-          sslCa: str(variables["ssl_ca"]),
-          sslCert: str(variables["ssl_cert"]),
-          sslKey: str(variables["ssl_key"]),
-          requireSecureTransport: str(
-            variables["require_secure_transport"],
-            "OFF",
-          ),
-        },
-        sessionStats: {
-          acceptedConnects: str(status["Ssl_accepts"], "0"),
-          finishedConnects: str(status["Ssl_finished_accepts"], "0"),
-        },
-      };
+        return {
+          sslEnabled: str(status["Ssl_cipher"]) !== "",
+          currentCipher: str(status["Ssl_cipher"], "None"),
+          sslVersion: str(status["Ssl_version"], "N/A"),
+          serverCertVerification: false, // Unknown in recent versions via variables
+          configuration: {
+            sslCa: str(variables["ssl_ca"]),
+            sslCert: str(variables["ssl_cert"]),
+            sslKey: str(variables["ssl_key"]),
+            requireSecureTransport: str(
+              variables["require_secure_transport"],
+              "OFF",
+            ),
+          },
+          sessionStats: {
+            acceptedConnects: str(status["Ssl_accepts"], "0"),
+            finishedConnects: str(status["Ssl_finished_accepts"], "0"),
+          },
+        };
+      } catch (error) {
+        if (error instanceof ZodError) {
+          return { success: false, error: formatZodError(error) };
+        }
+        const message = error instanceof Error ? error.message : String(error);
+        return { success: false, error: stripErrorPrefix(message) };
+      }
     },
   };
 }
@@ -130,15 +143,16 @@ export function createSecurityEncryptionStatusTool(
       idempotentHint: true,
     },
     handler: async (_params: unknown, _context: RequestContext) => {
-      // Check for keyring plugins
-      const keyringResult = await adapter.executeQuery(`
+      try {
+        // Check for keyring plugins
+        const keyringResult = await adapter.executeQuery(`
                 SELECT PLUGIN_NAME, PLUGIN_STATUS
                 FROM information_schema.PLUGINS
                 WHERE PLUGIN_NAME LIKE 'keyring%'
             `);
 
-      // Check encrypted tablespaces
-      const tablespaceResult = await adapter.executeQuery(`
+        // Check encrypted tablespaces
+        const tablespaceResult = await adapter.executeQuery(`
                 SELECT 
                     NAME,
                     ENCRYPTION
@@ -146,49 +160,56 @@ export function createSecurityEncryptionStatusTool(
                 WHERE ENCRYPTION = 'Y'
             `);
 
-      // Check encryption variables
-      const varsResult = await adapter.executeQuery(
-        "SHOW VARIABLES LIKE '%encrypt%'",
-      );
+        // Check encryption variables
+        const varsResult = await adapter.executeQuery(
+          "SHOW VARIABLES LIKE '%encrypt%'",
+        );
 
-      const variables: Record<string, unknown> = Object.fromEntries(
-        (varsResult.rows ?? []).map((r) => {
-          const record = r;
-          const varName =
-            typeof record["Variable_name"] === "string"
-              ? record["Variable_name"]
-              : "";
-          return [varName, record["Value"]];
-        }),
-      );
+        const variables: Record<string, unknown> = Object.fromEntries(
+          (varsResult.rows ?? []).map((r) => {
+            const record = r;
+            const varName =
+              typeof record["Variable_name"] === "string"
+                ? record["Variable_name"]
+                : "";
+            return [varName, record["Value"]];
+          }),
+        );
 
-      // Check redo/undo log encryption
-      const innodbVarsResult = await adapter.executeQuery(
-        "SHOW VARIABLES LIKE 'innodb_%encrypt%'",
-      );
+        // Check redo/undo log encryption
+        const innodbVarsResult = await adapter.executeQuery(
+          "SHOW VARIABLES LIKE 'innodb_%encrypt%'",
+        );
 
-      const innodbVars: Record<string, unknown> = Object.fromEntries(
-        (innodbVarsResult.rows ?? []).map((r) => {
-          const record = r;
-          const varName =
-            typeof record["Variable_name"] === "string"
-              ? record["Variable_name"]
-              : "";
-          return [varName, record["Value"]];
-        }),
-      );
+        const innodbVars: Record<string, unknown> = Object.fromEntries(
+          (innodbVarsResult.rows ?? []).map((r) => {
+            const record = r;
+            const varName =
+              typeof record["Variable_name"] === "string"
+                ? record["Variable_name"]
+                : "";
+            return [varName, record["Value"]];
+          }),
+        );
 
-      return {
-        keyringPlugins: keyringResult.rows ?? [],
-        keyringInstalled: (keyringResult.rows?.length ?? 0) > 0,
-        encryptedTablespaces: tablespaceResult.rows ?? [],
-        encryptedTablespaceCount: tablespaceResult.rows?.length ?? 0,
-        encryptionSettings: {
-          ...variables,
-          ...innodbVars,
-        },
-        tdeAvailable: (keyringResult.rows?.length ?? 0) > 0,
-      };
+        return {
+          keyringPlugins: keyringResult.rows ?? [],
+          keyringInstalled: (keyringResult.rows?.length ?? 0) > 0,
+          encryptedTablespaces: tablespaceResult.rows ?? [],
+          encryptedTablespaceCount: tablespaceResult.rows?.length ?? 0,
+          encryptionSettings: {
+            ...variables,
+            ...innodbVars,
+          },
+          tdeAvailable: (keyringResult.rows?.length ?? 0) > 0,
+        };
+      } catch (error) {
+        if (error instanceof ZodError) {
+          return { success: false, error: formatZodError(error) };
+        }
+        const message = error instanceof Error ? error.message : String(error);
+        return { success: false, error: stripErrorPrefix(message) };
+      }
     },
   };
 }
@@ -212,36 +233,36 @@ export function createSecurityPasswordValidateTool(
       idempotentHint: true,
     },
     handler: async (params: unknown, _context: RequestContext) => {
-      const { password } = PasswordValidateSchema.parse(params);
+      try {
+        const { password } = PasswordValidateSchema.parse(params);
 
-      // First check if validate_password component is installed
-      // by checking for its variables
-      const policyResult = await adapter.executeQuery(
-        "SHOW VARIABLES LIKE 'validate_password%'",
-      );
+        // First check if validate_password component is installed
+        // by checking for its variables
+        const policyResult = await adapter.executeQuery(
+          "SHOW VARIABLES LIKE 'validate_password%'",
+        );
 
-      const policy: Record<string, unknown> = Object.fromEntries(
-        (policyResult.rows ?? []).map((r) => {
-          const record = r;
-          const varName =
-            typeof record["Variable_name"] === "string"
-              ? record["Variable_name"]
-              : "";
-          return [varName, record["Value"]];
-        }),
-      );
+        const policy: Record<string, unknown> = Object.fromEntries(
+          (policyResult.rows ?? []).map((r) => {
+            const record = r;
+            const varName =
+              typeof record["Variable_name"] === "string"
+                ? record["Variable_name"]
+                : "";
+            return [varName, record["Value"]];
+          }),
+        );
 
-      // If no validate_password variables exist, component is not installed
-      if (Object.keys(policy).length === 0) {
-        return {
-          available: false,
-          message: "Password validation component not installed",
-          suggestion:
-            'Install with: INSTALL COMPONENT "file://component_validate_password"',
-        };
-      }
+        // If no validate_password variables exist, component is not installed
+        if (Object.keys(policy).length === 0) {
+          return {
+            available: false,
+            message: "Password validation component not installed",
+            suggestion:
+              'Install with: INSTALL COMPONENT "file://component_validate_password"',
+          };
+        }
 
-      try {
         // Use validate_password function
         const result = await adapter.executeQuery(
           "SELECT VALIDATE_PASSWORD_STRENGTH(?) as strength",
@@ -264,13 +285,25 @@ export function createSecurityPasswordValidateTool(
           meetsPolicy: strength >= 50, // General guideline
           policy,
         };
-      } catch {
-        return {
-          available: false,
-          message: "Password validation function failed",
-          suggestion:
-            'Reinstall with: INSTALL COMPONENT "file://component_validate_password"',
-        };
+      } catch (error) {
+        if (error instanceof ZodError) {
+          return { success: false, error: formatZodError(error) };
+        }
+        const message = error instanceof Error ? error.message : String(error);
+        // Check for known component-not-installed errors
+        const lower = message.toLowerCase();
+        if (
+          lower.includes("validate_password_strength") ||
+          lower.includes("function")
+        ) {
+          return {
+            available: false,
+            message: "Password validation function failed",
+            suggestion:
+              'Reinstall with: INSTALL COMPONENT "file://component_validate_password"',
+          };
+        }
+        return { success: false, error: stripErrorPrefix(message) };
       }
     },
   };

package/src/adapters/mysql/tools/shell/__tests__/backup.test.ts

@@ -299,6 +299,20 @@ describe("Shell Backup Tools", () => {
       expect(result.success).toBe(false);
       expect(result.error).toContain("Table not found");
     });
+
+    it("should return structured error for empty schemas array", async () => {
+      const tool = createShellDumpSchemasTool();
+      const result = (await tool.handler(
+        {
+          schemas: [],
+          outputDir: "/backup",
+        },
+        mockContext,
+      )) as any;
+
+      expect(result.success).toBe(false);
+      expect(result.error).toContain("At least one schema name is required");
+    });
   });
 
   describe("mysqlsh_dump_tables", () => {
@@ -454,5 +468,20 @@ describe("Shell Backup Tools", () => {
       expect(result.success).toBe(false);
       expect(result.error).toContain("Connection timeout");
     });
+
+    it("should return structured error for empty tables array", async () => {
+      const tool = createShellDumpTablesTool();
+      const result = (await tool.handler(
+        {
+          schema: "s",
+          tables: [],
+          outputDir: "/o",
+        },
+        mockContext,
+      )) as any;
+
+      expect(result.success).toBe(false);
+      expect(result.error).toContain("At least one table name is required");
+    });
   });
 });

package/src/adapters/mysql/tools/shell/backup.ts

@@ -4,6 +4,7 @@
  * Tools for creating database dumps using MySQL Shell.
  */
 
+import { ZodError } from "zod";
 import type {
   ToolDefinition,
   RequestContext,
@@ -15,6 +16,11 @@ import {
 } from "../../types/shell-types.js";
 import { escapeForJS, execShellJS } from "./common.js";
 
+/** Extract human-readable messages from a ZodError instead of raw JSON array */
+function formatZodError(error: ZodError): string {
+  return error.issues.map((i) => i.message).join("; ");
+}
+
 /**
  * Dump entire MySQL instance
  */
@@ -126,47 +132,54 @@ export function createShellDumpSchemasTool(): ToolDefinition {
       openWorldHint: true,
     },
     handler: async (params: unknown, _context: RequestContext) => {
-      const {
-        schemas,
-        outputDir,
-        threads,
-        compression,
-        dryRun,
-        includeTables,
-        excludeTables,
-        ddlOnly,
-      } = ShellDumpSchemasInputSchema.parse(params);
+      try {
+        const {
+          schemas,
+          outputDir,
+          threads,
+          compression,
+          dryRun,
+          includeTables,
+          excludeTables,
+          ddlOnly,
+        } = ShellDumpSchemasInputSchema.parse(params);
 
-      const escapedPath = outputDir.replace(/\\/g, "\\\\");
+        if (schemas.length === 0) {
+          return {
+            success: false,
+            error: "At least one schema name is required",
+          };
+        }
 
-      const options: string[] = [];
-      if (threads) {
-        options.push(`threads: ${threads}`);
-      }
-      if (compression && compression !== "zstd") {
-        options.push(`compression: "${compression}"`);
-      }
-      if (dryRun) {
-        options.push("dryRun: true");
-      }
-      if (includeTables && includeTables.length > 0) {
-        options.push(`includeTables: ${JSON.stringify(includeTables)}`);
-      }
-      if (excludeTables && excludeTables.length > 0) {
-        options.push(`excludeTables: ${JSON.stringify(excludeTables)}`);
-      }
-      // ddlOnly mode disables all metadata that requires extra privileges
-      if (ddlOnly) {
-        options.push("events: false");
-        options.push("triggers: false");
-        options.push("routines: false");
-      }
+        const escapedPath = outputDir.replace(/\\/g, "\\\\");
 
-      const optionsStr =
-        options.length > 0 ? `, { ${options.join(", ")} }` : "";
-      const jsCode = `return util.dumpSchemas(${JSON.stringify(schemas)}, "${escapedPath}"${optionsStr});`;
+        const options: string[] = [];
+        if (threads) {
+          options.push(`threads: ${threads}`);
+        }
+        if (compression && compression !== "zstd") {
+          options.push(`compression: "${compression}"`);
+        }
+        if (dryRun) {
+          options.push("dryRun: true");
+        }
+        if (includeTables && includeTables.length > 0) {
+          options.push(`includeTables: ${JSON.stringify(includeTables)}`);
+        }
+        if (excludeTables && excludeTables.length > 0) {
+          options.push(`excludeTables: ${JSON.stringify(excludeTables)}`);
+        }
+        // ddlOnly mode disables all metadata that requires extra privileges
+        if (ddlOnly) {
+          options.push("events: false");
+          options.push("triggers: false");
+          options.push("routines: false");
+        }
+
+        const optionsStr =
+          options.length > 0 ? `, { ${options.join(", ")} }` : "";
+        const jsCode = `return util.dumpSchemas(${JSON.stringify(schemas)}, "${escapedPath}"${optionsStr});`;
 
-      try {
         const result = await execShellJS(jsCode, { timeout: 3600000 });
         return {
           success: true,
@@ -177,6 +190,9 @@ export function createShellDumpSchemasTool(): ToolDefinition {
           result,
         };
       } catch (error) {
+        if (error instanceof ZodError) {
+          return { success: false, error: formatZodError(error) };
+        }
         const errorMessage =
           error instanceof Error ? error.message : String(error);
         if (
@@ -186,13 +202,11 @@ export function createShellDumpSchemasTool(): ToolDefinition {
         ) {
           return {
             success: false,
-            schemas,
-            outputDir,
             error: `Dump failed due to missing privileges: ${errorMessage}.`,
             hint: "Set ddlOnly: true to skip events, triggers, and routines.",
           };
         }
-        return { success: false, schemas, outputDir, error: errorMessage };
+        return { success: false, error: errorMessage };
       }
     },
   };
@@ -215,34 +229,43 @@ export function createShellDumpTablesTool(): ToolDefinition {
       openWorldHint: true,
     },
     handler: async (params: unknown, _context: RequestContext) => {
-      const { schema, tables, outputDir, threads, compression, where, all } =
-        ShellDumpTablesInputSchema.parse(params);
+      try {
+        const { schema, tables, outputDir, threads, compression, where, all } =
+          ShellDumpTablesInputSchema.parse(params);
 
-      const escapedPath = outputDir.replace(/\\/g, "\\\\");
+        if (tables.length === 0) {
+          return {
+            success: false,
+            error: "At least one table name is required",
+          };
+        }
 
-      const options: string[] = [];
-      if (threads) {
-        options.push(`threads: ${threads}`);
-      }
-      if (compression && compression !== "zstd") {
-        options.push(`compression: "${compression}"`);
-      }
-      if (where && Object.keys(where).length > 0) {
-        const whereEntries = Object.entries(where)
-          .map(([tbl, cond]) => `"${escapeForJS(tbl)}": "${escapeForJS(cond)}"`)
-          .join(", ");
-        options.push(`where: { ${whereEntries} }`);
-      }
-      // When all is explicitly false, disable triggers/routines dumping
-      if (!all) {
-        options.push("triggers: false");
-      }
+        const escapedPath = outputDir.replace(/\\/g, "\\\\");
 
-      const optionsStr =
-        options.length > 0 ? `, { ${options.join(", ")} }` : "";
-      const jsCode = `return util.dumpTables("${schema}", ${JSON.stringify(tables)}, "${escapedPath}"${optionsStr});`;
+        const options: string[] = [];
+        if (threads) {
+          options.push(`threads: ${threads}`);
+        }
+        if (compression && compression !== "zstd") {
+          options.push(`compression: "${compression}"`);
+        }
+        if (where && Object.keys(where).length > 0) {
+          const whereEntries = Object.entries(where)
+            .map(
+              ([tbl, cond]) => `"${escapeForJS(tbl)}": "${escapeForJS(cond)}"`,
+            )
+            .join(", ");
+          options.push(`where: { ${whereEntries} }`);
+        }
+        // When all is explicitly false, disable triggers/routines dumping
+        if (!all) {
+          options.push("triggers: false");
+        }
+
+        const optionsStr =
+          options.length > 0 ? `, { ${options.join(", ")} }` : "";
+        const jsCode = `return util.dumpTables("${schema}", ${JSON.stringify(tables)}, "${escapedPath}"${optionsStr});`;
 
-      try {
         const result = await execShellJS(jsCode, { timeout: 3600000 });
         return {
           success: true,
@@ -253,6 +276,9 @@ export function createShellDumpTablesTool(): ToolDefinition {
           result,
         };
       } catch (error) {
+        if (error instanceof ZodError) {
+          return { success: false, error: formatZodError(error) };
+        }
         const errorMessage =
           error instanceof Error ? error.message : String(error);
 
@@ -269,9 +295,6 @@ export function createShellDumpTablesTool(): ToolDefinition {
 
           return {
             success: false,
-            schema,
-            tables,
-            outputDir,
             error: `Dump failed due to missing privileges: ${errorMessage}.`,
             hint:
               specificPrivilege === "EVENT" || specificPrivilege === "TRIGGER"
@@ -284,9 +307,6 @@ export function createShellDumpTablesTool(): ToolDefinition {
         if (errorMessage.includes("Fatal error during dump")) {
           return {
             success: false,
-            schema,
-            tables,
-            outputDir,
             error: errorMessage.includes("Writing schema metadata")
               ? `Dump failed while writing schema metadata: ${errorMessage}.`
               : `Dump failed: ${errorMessage}.`,
@@ -296,9 +316,6 @@ export function createShellDumpTablesTool(): ToolDefinition {
 
         return {
           success: false,
-          schema,
-          tables,
-          outputDir,
           error: errorMessage,
         };
       }