@neverinfamous/mysql-mcp 2.1.0 → 2.3.0

package/src/adapters/mysql/prompts/clusterSetup.ts

@@ -1,17 +1,18 @@
 /**
  * MySQL Prompt - InnoDB Cluster Setup
- * 
+ *
  * Complete InnoDB Cluster and Group Replication setup guide.
  */
-import type { PromptDefinition, RequestContext } from '../../../types/index.js';
+import type { PromptDefinition, RequestContext } from "../../../types/index.js";
 
 export function createSetupClusterPrompt(): PromptDefinition {
-    return {
-        name: 'mysql_setup_cluster',
-        description: 'Complete MySQL InnoDB Cluster and Group Replication setup guide',
-        arguments: [],
-        handler: (_args: Record<string, string>, _context: RequestContext) => {
-            return Promise.resolve(`# MySQL InnoDB Cluster Setup Guide
+  return {
+    name: "mysql_setup_cluster",
+    description:
+      "Complete MySQL InnoDB Cluster and Group Replication setup guide",
+    arguments: [],
+    handler: (_args: Record<string, string>, _context: RequestContext) => {
+      return Promise.resolve(`# MySQL InnoDB Cluster Setup Guide
 
 InnoDB Cluster provides a complete high availability solution using Group Replication, MySQL Shell, and MySQL Router.
 
@@ -113,6 +114,6 @@ cluster.setPrimaryInstance('admin@new-primary:3306')
 4. **Test failover regularly** in staging
 
 Start by checking cluster status with \`mysql_cluster_status\`.`);
-        }
-    };
+    },
+  };
 }

package/src/adapters/mysql/prompts/docstoreSetup.ts

@@ -1,17 +1,17 @@
 /**
  * MySQL Prompt - Document Store Setup
- * 
+ *
  * Complete Document Store / X DevAPI setup guide.
  */
-import type { PromptDefinition, RequestContext } from '../../../types/index.js';
+import type { PromptDefinition, RequestContext } from "../../../types/index.js";
 
 export function createSetupDocstorePrompt(): PromptDefinition {
-    return {
-        name: 'mysql_setup_docstore',
-        description: 'Complete MySQL Document Store and X DevAPI setup guide',
-        arguments: [],
-        handler: (_args: Record<string, string>, _context: RequestContext) => {
-            return Promise.resolve(`# MySQL Document Store Setup Guide
+  return {
+    name: "mysql_setup_docstore",
+    description: "Complete MySQL Document Store and X DevAPI setup guide",
+    arguments: [],
+    handler: (_args: Record<string, string>, _context: RequestContext) => {
+      return Promise.resolve(`# MySQL Document Store Setup Guide
 
 MySQL Document Store allows you to store and query JSON documents using collections, similar to NoSQL databases.
 
@@ -118,6 +118,6 @@ db.users.createIndex("email_idx", {
 3. **Schema not found**: Create database first
 
 Start by listing collections with \`mysql_doc_list_collections\`.`);
-        }
-    };
+    },
+  };
 }

package/src/adapters/mysql/prompts/eventScheduler.ts

@@ -1,17 +1,17 @@
 /**
  * MySQL Prompt - Event Scheduler Setup
- * 
+ *
  * Complete Event Scheduler configuration guide.
  */
-import type { PromptDefinition, RequestContext } from '../../../types/index.js';
+import type { PromptDefinition, RequestContext } from "../../../types/index.js";
 
 export function createSetupEventsPrompt(): PromptDefinition {
-    return {
-        name: 'mysql_setup_events',
-        description: 'Complete MySQL Event Scheduler setup and configuration guide',
-        arguments: [],
-        handler: (_args: Record<string, string>, _context: RequestContext) => {
-            return Promise.resolve(`# MySQL Event Scheduler Setup Guide
+  return {
+    name: "mysql_setup_events",
+    description: "Complete MySQL Event Scheduler setup and configuration guide",
+    arguments: [],
+    handler: (_args: Record<string, string>, _context: RequestContext) => {
+      return Promise.resolve(`# MySQL Event Scheduler Setup Guide
 
 MySQL Event Scheduler allows you to schedule SQL statements to run at specific times or intervals.
 
@@ -98,6 +98,6 @@ DO
 3. **Event disappeared**: Check ON COMPLETION PRESERVE setting
 
 Start by checking the scheduler status with \`mysql_scheduler_status\`.`);
-        }
-    };
+    },
+  };
 }

package/src/adapters/mysql/prompts/healthCheck.ts

@@ -1,24 +1,29 @@
 /**
  * MySQL Prompt - Database Health Check
- * 
+ *
  * Guides user through comprehensive database health assessment.
  */
-import type { PromptDefinition, RequestContext } from '../../../types/index.js';
+import type { PromptDefinition, RequestContext } from "../../../types/index.js";
 
 export function createDatabaseHealthCheckPrompt(): PromptDefinition {
-    return {
-        name: 'mysql_database_health_check',
-        description: 'Comprehensive database health assessment workflow',
-        arguments: [
-            { name: 'focus', description: 'Optional focus area: connections, performance, replication, storage', required: false }
-        ],
-        handler: (args: Record<string, string>, _context: RequestContext) => {
-            const focus = args['focus'] ?? 'all';
-
-            return Promise.resolve(`# MySQL Database Health Check
+  return {
+    name: "mysql_database_health_check",
+    description: "Comprehensive database health assessment workflow",
+    arguments: [
+      {
+        name: "focus",
+        description:
+          "Optional focus area: connections, performance, replication, storage",
+        required: false,
+      },
+    ],
+    handler: (args: Record<string, string>, _context: RequestContext) => {
+      const focus = args["focus"] ?? "all";
+
+      return Promise.resolve(`# MySQL Database Health Check
 
 Perform a comprehensive health assessment for this MySQL database.
-${focus !== 'all' ? `**Focus area:** ${focus}` : ''}
+${focus !== "all" ? `**Focus area:** ${focus}` : ""}
 
 ## Step 1: Check Connection Health
 Use \`mysql://health\` resource or \`mysql_pool_stats\` tool to verify:
@@ -51,6 +56,6 @@ Based on findings, provide:
 3. Maintenance tasks to schedule
 
 Please proceed with the health check and report findings.`);
-        }
-    };
+    },
+  };
 }

package/src/adapters/mysql/prompts/index.ts

@@ -1,31 +1,38 @@
 /**
  * MySQL MCP Prompts
- * 
+ *
  * AI-powered prompts for query building, schema design, and optimization.
  * 19 prompts total.
  */
-import type { MySQLAdapter } from '../MySQLAdapter.js';
-import type { PromptDefinition, RequestContext, ToolDefinition } from '../../../types/index.js';
-import { generateCompactIndex, generateDiscoveryPrompt } from '../../../utils/promptGenerator.js';
+import type { MySQLAdapter } from "../MySQLAdapter.js";
+import type {
+  PromptDefinition,
+  RequestContext,
+  ToolDefinition,
+} from "../../../types/index.js";
+import {
+  generateCompactIndex,
+  generateDiscoveryPrompt,
+} from "../../../utils/promptGenerator.js";
 
 // Modular prompt imports
-import { createDatabaseHealthCheckPrompt } from './healthCheck.js';
-import { createBackupStrategyPrompt } from './backupStrategy.js';
-import { createIndexTuningPrompt } from './indexTuning.js';
-import { createSetupRouterPrompt } from './routerSetup.js';
-import { createSetupProxysqlPrompt } from './proxysqlSetup.js';
-import { createSetupReplicationPrompt } from './replicationSetup.js';
-import { createSetupMysqlshPrompt } from './mysqlshSetup.js';
+import { createDatabaseHealthCheckPrompt } from "./healthCheck.js";
+import { createBackupStrategyPrompt } from "./backupStrategy.js";
+import { createIndexTuningPrompt } from "./indexTuning.js";
+import { createSetupRouterPrompt } from "./routerSetup.js";
+import { createSetupProxysqlPrompt } from "./proxysqlSetup.js";
+import { createSetupReplicationPrompt } from "./replicationSetup.js";
+import { createSetupMysqlshPrompt } from "./mysqlshSetup.js";
 // New prompts (5)
-import { createSetupEventsPrompt } from './eventScheduler.js';
-import { createSysSchemaGuidePrompt } from './sysSchema.js';
-import { createSetupSpatialPrompt } from './spatialSetup.js';
-import { createSetupClusterPrompt } from './clusterSetup.js';
-import { createSetupDocstorePrompt } from './docstoreSetup.js';
+import { createSetupEventsPrompt } from "./eventScheduler.js";
+import { createSysSchemaGuidePrompt } from "./sysSchema.js";
+import { createSetupSpatialPrompt } from "./spatialSetup.js";
+import { createSetupClusterPrompt } from "./clusterSetup.js";
+import { createSetupDocstorePrompt } from "./docstoreSetup.js";
 
 /**
- * Get all MySQL prompts (14 total)
- * 
+ * Get all MySQL prompts (19 total)
+ *
  * Core (7):
  * - mysql_tool_index - Lazy hydration tool index
  * - mysql_quick_query - Quick query shortcut
@@ -34,7 +41,7 @@ import { createSetupDocstorePrompt } from './docstoreSetup.js';
  * - mysql_schema_design - Schema design guidance
  * - mysql_performance_analysis - Query performance analysis
  * - mysql_migration - Migration script generation
- * 
+ *
  * Extended (7):
  * - mysql_database_health_check - Comprehensive health assessment
  * - mysql_backup_strategy - Enterprise backup planning
@@ -43,36 +50,43 @@ import { createSetupDocstorePrompt } from './docstoreSetup.js';
  * - mysql_setup_proxysql - ProxySQL configuration
  * - mysql_setup_replication - Replication setup guide
  * - mysql_setup_shell - MySQL Shell usage guide
+ *
+ * New (5):
+ * - mysql_setup_events - Event Scheduler setup guide
+ * - mysql_sys_schema_guide - sys schema usage and diagnostics
+ * - mysql_setup_spatial - Spatial/GIS data setup guide
+ * - mysql_setup_cluster - InnoDB Cluster/Group Replication guide
+ * - mysql_setup_docstore - Document Store / X DevAPI guide
  */
 export function getMySQLPrompts(adapter: MySQLAdapter): PromptDefinition[] {
-    // Get tool definitions for generating indexes
-    const toolDefs = adapter.getToolDefinitions();
-
-    return [
-        // Lazy hydration prompts
-        createToolIndexPrompt(toolDefs),
-        createQuickQueryPrompt(),
-        createQuickSchemaPrompt(),
-        // Original prompts
-        createQueryBuilderPrompt(),
-        createSchemaDesignPrompt(),
-        createPerformanceAnalysisPrompt(),
-        createMigrationPrompt(),
-        // Extended prompts (modular imports)
-        createDatabaseHealthCheckPrompt(),
-        createBackupStrategyPrompt(),
-        createIndexTuningPrompt(),
-        createSetupRouterPrompt(),
-        createSetupProxysqlPrompt(),
-        createSetupReplicationPrompt(),
-        createSetupMysqlshPrompt(),
-        // New prompts (5)
-        createSetupEventsPrompt(),
-        createSysSchemaGuidePrompt(),
-        createSetupSpatialPrompt(),
-        createSetupClusterPrompt(),
-        createSetupDocstorePrompt()
-    ];
+  // Get tool definitions for generating indexes
+  const toolDefs = adapter.getToolDefinitions();
+
+  return [
+    // Lazy hydration prompts
+    createToolIndexPrompt(toolDefs),
+    createQuickQueryPrompt(),
+    createQuickSchemaPrompt(),
+    // Original prompts
+    createQueryBuilderPrompt(),
+    createSchemaDesignPrompt(),
+    createPerformanceAnalysisPrompt(),
+    createMigrationPrompt(),
+    // Extended prompts (modular imports)
+    createDatabaseHealthCheckPrompt(),
+    createBackupStrategyPrompt(),
+    createIndexTuningPrompt(),
+    createSetupRouterPrompt(),
+    createSetupProxysqlPrompt(),
+    createSetupReplicationPrompt(),
+    createSetupMysqlshPrompt(),
+    // New prompts (5)
+    createSetupEventsPrompt(),
+    createSysSchemaGuidePrompt(),
+    createSetupSpatialPrompt(),
+    createSetupClusterPrompt(),
+    createSetupDocstorePrompt(),
+  ];
 }
 
 // =============================================================================
@@ -80,19 +94,30 @@ export function getMySQLPrompts(adapter: MySQLAdapter): PromptDefinition[] {
 // =============================================================================
 
 function createQueryBuilderPrompt(): PromptDefinition {
-    return {
-        name: 'mysql_query_builder',
-        description: 'Help build SQL queries for common operations',
-        arguments: [
-            { name: 'operation', description: 'Type of query (SELECT, INSERT, UPDATE, DELETE)', required: true },
-            { name: 'table', description: 'Target table name', required: true },
-            { name: 'description', description: 'What you want to accomplish', required: true }
-        ],
-        handler: (args: Record<string, string>, _context: RequestContext): Promise<string> => {
-            return Promise.resolve(`
-You are a MySQL query expert. Help build a ${args['operation']} query for the table "${args['table']}".
-
-User's goal: ${args['description']}
+  return {
+    name: "mysql_query_builder",
+    description: "Help build SQL queries for common operations",
+    arguments: [
+      {
+        name: "operation",
+        description: "Type of query (SELECT, INSERT, UPDATE, DELETE)",
+        required: true,
+      },
+      { name: "table", description: "Target table name", required: true },
+      {
+        name: "description",
+        description: "What you want to accomplish",
+        required: true,
+      },
+    ],
+    handler: (
+      args: Record<string, string>,
+      _context: RequestContext,
+    ): Promise<string> => {
+      return Promise.resolve(`
+You are a MySQL query expert. Help build a ${args["operation"]} query for the table "${args["table"]}".
+
+User's goal: ${args["description"]}
 
 Please provide:
 1. The complete SQL query with proper escaping
@@ -106,23 +131,23 @@ Use MySQL best practices:
 - Include appropriate WHERE clauses
 - Consider using LIMIT for large result sets
 `);
-        }
-    };
+    },
+  };
 }
 
 /**
  * Tool index prompt - shows all available tools in a compact format
  */
 function createToolIndexPrompt(toolDefs: ToolDefinition[]): PromptDefinition {
-    const compactIndex = generateCompactIndex(toolDefs);
-    const discovery = generateDiscoveryPrompt(toolDefs);
-
-    return {
-        name: 'mysql_tool_index',
-        description: 'Show all available MySQL tools organized by category',
-        arguments: [],
-        handler: (_args: Record<string, string>, _context: RequestContext) => {
-            return Promise.resolve(`
+  const compactIndex = generateCompactIndex(toolDefs);
+  const discovery = generateDiscoveryPrompt(toolDefs);
+
+  return {
+    name: "mysql_tool_index",
+    description: "Show all available MySQL tools organized by category",
+    arguments: [],
+    handler: (_args: Record<string, string>, _context: RequestContext) => {
+      return Promise.resolve(`
 # MySQL MCP Tool Index
 
 This server provides ${String(toolDefs.length)} MySQL tools for database operations.
@@ -134,62 +159,74 @@ ${compactIndex}
 
 **Usage**: Call any tool by name with the required arguments. Use \`mysql_read_query\` for SELECT queries and \`mysql_write_query\` for INSERT/UPDATE/DELETE.
 `);
-        }
-    };
+    },
+  };
 }
 
 /**
  * Quick query prompt - shortcut for running queries
  */
 function createQuickQueryPrompt(): PromptDefinition {
-    return {
-        name: 'mysql_quick_query',
-        description: 'Quickly run a SQL query - shortcut for mysql_read_query or mysql_write_query',
-        arguments: [
-            { name: 'sql', description: 'SQL query to execute', required: true },
-            { name: 'type', description: 'Query type: read or write (default: read)', required: false }
-        ],
-        handler: (args: Record<string, string>, _context: RequestContext) => {
-            const queryType = args['type']?.toLowerCase() === 'write' ? 'write' : 'read';
-            const toolName = queryType === 'write' ? 'mysql_write_query' : 'mysql_read_query';
-
-            return Promise.resolve(`
+  return {
+    name: "mysql_quick_query",
+    description:
+      "Quickly run a SQL query - shortcut for mysql_read_query or mysql_write_query",
+    arguments: [
+      { name: "sql", description: "SQL query to execute", required: true },
+      {
+        name: "type",
+        description: "Query type: read or write (default: read)",
+        required: false,
+      },
+    ],
+    handler: (args: Record<string, string>, _context: RequestContext) => {
+      const queryType =
+        args["type"]?.toLowerCase() === "write" ? "write" : "read";
+      const toolName =
+        queryType === "write" ? "mysql_write_query" : "mysql_read_query";
+
+      return Promise.resolve(`
 Execute this ${queryType} query using the \`${toolName}\` tool:
 
 \`\`\`sql
-${args['sql']}
+${args["sql"]}
 \`\`\`
 
 **Tool to use**: \`${toolName}\`
-**Arguments**: \`{ "query": "${(args['sql'] ?? '').replace(/\\/g, '\\\\').replace(/"/g, '\\"')}" }\`
+**Arguments**: \`{ "query": "${(args["sql"] ?? "").replace(/\\/g, "\\\\").replace(/"/g, '\\"')}" }\`
 `);
-        }
-    };
+    },
+  };
 }
 
 /**
  * Quick schema prompt - shortcut for exploring database schema
  */
 function createQuickSchemaPrompt(): PromptDefinition {
-    return {
-        name: 'mysql_quick_schema',
-        description: 'Quickly explore database schema - lists tables or describes a specific table',
-        arguments: [
-            { name: 'table', description: 'Table name to describe (leave empty to list all tables)', required: false }
-        ],
-        handler: (args: Record<string, string>, _context: RequestContext) => {
-            if (args['table']) {
-                return Promise.resolve(`
-Describe the structure of table **${args['table']}** using the \`mysql_describe_table\` tool:
+  return {
+    name: "mysql_quick_schema",
+    description:
+      "Quickly explore database schema - lists tables or describes a specific table",
+    arguments: [
+      {
+        name: "table",
+        description: "Table name to describe (leave empty to list all tables)",
+        required: false,
+      },
+    ],
+    handler: (args: Record<string, string>, _context: RequestContext) => {
+      if (args["table"]) {
+        return Promise.resolve(`
+Describe the structure of table **${args["table"]}** using the \`mysql_describe_table\` tool:
 
 **Tool to use**: \`mysql_describe_table\`
-**Arguments**: \`{ "table": "${args['table']}" }\`
+**Arguments**: \`{ "table": "${args["table"]}" }\`
 
 This will show columns, types, indexes, and constraints.
 `);
-            }
+      }
 
-            return Promise.resolve(`
+      return Promise.resolve(`
 List all tables in the database using the \`mysql_list_tables\` tool:
 
 **Tool to use**: \`mysql_list_tables\`
@@ -197,23 +234,31 @@ List all tables in the database using the \`mysql_list_tables\` tool:
 
 This will show all tables with their row counts and metadata.
 `);
-        }
-    };
+    },
+  };
 }
 
 function createSchemaDesignPrompt(): PromptDefinition {
-    return {
-        name: 'mysql_schema_design',
-        description: 'Help design table schemas',
-        arguments: [
-            { name: 'entity', description: 'What entity/data you want to store', required: true },
-            { name: 'requirements', description: 'Any specific requirements', required: false }
-        ],
-        handler: (args: Record<string, string>, _context: RequestContext) => {
-            return Promise.resolve(`
-You are a MySQL database architect. Design a schema for: ${args['entity']}
-
-${args['requirements'] ? `Requirements: ${args['requirements']}` : ''}
+  return {
+    name: "mysql_schema_design",
+    description: "Help design table schemas",
+    arguments: [
+      {
+        name: "entity",
+        description: "What entity/data you want to store",
+        required: true,
+      },
+      {
+        name: "requirements",
+        description: "Any specific requirements",
+        required: false,
+      },
+    ],
+    handler: (args: Record<string, string>, _context: RequestContext) => {
+      return Promise.resolve(`
+You are a MySQL database architect. Design a schema for: ${args["entity"]}
+
+${args["requirements"] ? `Requirements: ${args["requirements"]}` : ""}
 
 Please provide:
 1. CREATE TABLE statement with:
@@ -237,27 +282,35 @@ Best practices to follow:
 - Consider JSON columns for flexible data
 - Add appropriate indexes based on query patterns
 `);
-        }
-    };
+    },
+  };
 }
 
 function createPerformanceAnalysisPrompt(): PromptDefinition {
-    return {
-        name: 'mysql_performance_analysis',
-        description: 'Analyze and optimize slow queries',
-        arguments: [
-            { name: 'query', description: 'The slow query to analyze', required: true },
-            { name: 'context', description: 'Table structure and data volume', required: false }
-        ],
-        handler: (args: Record<string, string>, _context: RequestContext) => {
-            return Promise.resolve(`
+  return {
+    name: "mysql_performance_analysis",
+    description: "Analyze and optimize slow queries",
+    arguments: [
+      {
+        name: "query",
+        description: "The slow query to analyze",
+        required: true,
+      },
+      {
+        name: "context",
+        description: "Table structure and data volume",
+        required: false,
+      },
+    ],
+    handler: (args: Record<string, string>, _context: RequestContext) => {
+      return Promise.resolve(`
 You are a MySQL performance expert. Analyze this query:
 
 \`\`\`sql
-${args['query']}
+${args["query"]}
 \`\`\`
 
-${args['context'] ? `Context: ${args['context']}` : ''}
+${args["context"] ? `Context: ${args["context"]}` : ""}
 
 Please provide:
 1. Run EXPLAIN on the query and interpret results
@@ -280,23 +333,27 @@ Use these MySQL tools to analyze:
 - mysql_index_usage to check index utilization
 - mysql_table_stats for data volume
 `);
-        }
-    };
+    },
+  };
 }
 
 function createMigrationPrompt(): PromptDefinition {
-    return {
-        name: 'mysql_migration',
-        description: 'Generate migration scripts for schema changes',
-        arguments: [
-            { name: 'change', description: 'What schema change you need', required: true },
-            { name: 'table', description: 'Target table name', required: true }
-        ],
-        handler: (args: Record<string, string>, _context: RequestContext) => {
-            return Promise.resolve(`
-You are a MySQL migration expert. Create a migration for: ${args['change']}
-
-Target table: ${args['table']}
+  return {
+    name: "mysql_migration",
+    description: "Generate migration scripts for schema changes",
+    arguments: [
+      {
+        name: "change",
+        description: "What schema change you need",
+        required: true,
+      },
+      { name: "table", description: "Target table name", required: true },
+    ],
+    handler: (args: Record<string, string>, _context: RequestContext) => {
+      return Promise.resolve(`
+You are a MySQL migration expert. Create a migration for: ${args["change"]}
+
+Target table: ${args["table"]}
 
 Please provide:
 1. UP migration (apply the change):
@@ -324,6 +381,6 @@ Best practices:
 - Run during low-traffic periods
 - Monitor for lock contention
 `);
-        }
-    };
+    },
+  };
 }