Skip to content
Chris edited this page Jul 5, 2026 · 146 revisions

Tool Reference

npm version License TypeScript
Model Context Protocol Docker Support

🚀 Value Proposition

Unleash God-Mode on your data layer. Equip your AI agent with an uncompromising arsenal of 241 highly specialized tools, intelligently grouped across 28 categories. From surgical schema migrations and deep query optimizations to autonomous vector search, this ultimate enterprise toolkit guarantees maximum performance, zero downtime, and unmatched self-healing capabilities.

Enterprise Reliability: Every tool returns structured {success, error, code, category, suggestion, recoverable} responses—no raw exceptions, no silent failures. Nonexistent tables gracefully return {exists: false, table}. See the README for details.

Dual-Schema Pattern: Tools use a plain z.object() Base schema for MCP parameter visibility, and a z.preprocess() wrapper for handler parsing to support aliases and coercion without breaking standard JSON Schema generation.


Master Core Database Operations (12 tools)

Tool Description Parameters
mysql_read_query Execute SELECT with parameter binding query, params
mysql_write_query Execute INSERT/UPDATE/DELETE query, params
mysql_list_tables List tables with metadata None
mysql_describe_table Get column definitions tableName
mysql_create_table CREATE TABLE with engine/charset tableName, columns
mysql_drop_table DROP TABLE with IF EXISTS tableName
mysql_create_index CREATE INDEX (BTREE, HASH, FULLTEXT) tableName, indexName, columns
mysql_get_indexes SHOW INDEX FROM table tableName
mysql_enable_versioning Enable OCC on a table tableName
mysql_disable_versioning Disable OCC on a table tableName
mysql_check_version Get current _version of a row tableName, id, idColumn (optional)
mysql_conditional_update Update row conditionally. v3.2.2: Aliases for data/conditions tableName, updates, conditions, expectedVersion

Govern Schema and Structure (11 tools)

Tool Description Parameters
mysql_list_schemas List databases/schemas summary, limit, compact
mysql_create_schema CREATE DATABASE summary, limit, compact
mysql_drop_schema DROP DATABASE summary, limit, compact
mysql_list_views List views in schema summary, limit, compact
mysql_create_view CREATE OR REPLACE VIEW summary, limit, compact
mysql_drop_view DROP VIEW summary, limit, compact
mysql_list_stored_procedures List stored procedures summary, limit, compact
mysql_list_functions List stored functions summary, limit, compact
mysql_list_triggers List triggers summary, limit, compact
mysql_list_constraints List foreign keys and checks summary, limit, compact
mysql_list_events List scheduled events (Schema mapping) summary, limit, compact

Control Transactions Atomically (7 tools)

Tool Description Parameters
mysql_transaction_begin START TRANSACTION with isolation level summary, limit, compact
mysql_transaction_commit COMMIT summary, limit, compact
mysql_transaction_rollback ROLLBACK summary, limit, compact
mysql_transaction_savepoint SAVEPOINT name summary, limit, compact
mysql_transaction_release RELEASE SAVEPOINT summary, limit, compact
mysql_transaction_rollback_to ROLLBACK TO SAVEPOINT summary, limit, compact
mysql_transaction_execute Execute statements atomically summary, limit, compact

Process JSON Documents (17 tools)

Tool Description Parameters
mysql_json_extract JSON_EXTRACT with path summary, limit, compact
mysql_json_set JSON_SET to modify values summary, limit, compact
mysql_json_insert JSON_INSERT (no overwrite) summary, limit, compact
mysql_json_replace JSON_REPLACE (only existing) summary, limit, compact
mysql_json_remove JSON_REMOVE paths summary, limit, compact
mysql_json_contains JSON_CONTAINS for filtering summary, limit, compact
mysql_json_keys JSON_KEYS to list object keys summary, limit, compact
mysql_json_array_append JSON_ARRAY_APPEND summary, limit, compact
mysql_json_get Simple JSON value extraction summary, limit, compact
mysql_json_update Update JSON field by path summary, limit, compact
mysql_json_search Search JSON for string value summary, limit, compact
mysql_json_validate Validate JSON structure summary, limit, compact
mysql_json_merge JSON_MERGE_PATCH / PRESERVE summary, limit, compact
mysql_json_diff Compare two JSON documents summary, limit, compact
mysql_json_normalize Normalize keys and formats summary, limit, compact
mysql_json_stats Calculate depth, keys count, size summary, limit, compact
mysql_json_index_suggest Suggest generated columns for indexing summary, limit, compact

Leverage Document Store Features (9 tools)

Treat MySQL like a NoSQL document database (MySQL 5.7+). v3.2.2: Alias handling for collectionName.

Tool Description Parameters
mysql_doc_list_collections List JSON collections summary, limit, compact
mysql_doc_create_collection Create new collection summary, limit, compact
mysql_doc_drop_collection Drop collection summary, limit, compact
mysql_doc_find Find documents (NoSQL-style criteria) summary, limit, compact
mysql_doc_add Add documents to collection summary, limit, compact
mysql_doc_modify Modify documents matching criteria summary, limit, compact
mysql_doc_remove Remove documents matching criteria summary, limit, compact
mysql_doc_create_index Create index on JSON path summary, limit, compact
mysql_doc_collection_info Get collection stats summary, limit, compact

Process and Match Text (6 tools)

Tool Description Parameters
mysql_regexp_match REGEXP pattern matching summary, limit, compact
mysql_like_search LIKE with wildcards summary, limit, compact
mysql_soundex SOUNDEX phonetic matching summary, limit, compact
mysql_substring SUBSTRING extraction summary, limit, compact
mysql_concat String concatenation summary, limit, compact
mysql_collation_convert Character set conversion summary, limit, compact

Execute FULLTEXT Search (5 tools)

Tool Description Parameters
mysql_fulltext_create Create FULLTEXT index summary, limit, compact
mysql_fulltext_drop Drop FULLTEXT index summary, limit, compact
mysql_fulltext_search MATCH...AGAINST natural language. v2.2: maxLength parameter summary, limit, compact
mysql_fulltext_boolean Boolean mode search. v2.2: maxLength parameter summary, limit, compact
mysql_fulltext_expand WITH QUERY EXPANSION. v2.2: maxLength parameter summary, limit, compact

Analyze Spatial and GIS Data (12 tools)

Tool Description Parameters
mysql_spatial_create_column Add POINT/POLYGON column with SRID summary, limit, compact
mysql_spatial_create_index Create SPATIAL index summary, limit, compact
mysql_spatial_point Create POINT from coords summary, limit, compact
mysql_spatial_polygon Create POLYGON from points summary, limit, compact
mysql_spatial_distance ST_Distance (Cartesian) summary, limit, compact
mysql_spatial_distance_sphere ST_Distance_Sphere (Earth) summary, limit, compact
mysql_spatial_contains ST_Contains check summary, limit, compact
mysql_spatial_within ST_Within check summary, limit, compact
mysql_spatial_intersection Get geometry intersection summary, limit, compact
mysql_spatial_buffer Create buffer around geometry summary, limit, compact
mysql_spatial_transform Transform SRID (CS conversion) summary, limit, compact
mysql_spatial_geojson Import/Export GeoJSON summary, limit, compact

Calculate Advanced Statistics (20 tools)

Tool Description Parameters
mysql_stats_descriptive Mean, median, stddev, variance summary, limit, compact
mysql_stats_percentiles Calculate percentiles (p50, p90, p99) summary, limit, compact
mysql_stats_correlation Pearson correlation coefficient summary, limit, compact
mysql_stats_distribution Frequency distribution summary, limit, compact
mysql_stats_time_series Time-bucketed aggregation summary, limit, compact
mysql_stats_regression Simple linear regression summary, limit, compact
mysql_stats_sampling Random row sampling summary, limit, compact
mysql_stats_histogram Generate histogram buckets summary, limit, compact
mysql_stats_row_number ROW_NUMBER() window function summary, limit, compact
mysql_stats_rank RANK()/DENSE_RANK() window function summary, limit, compact
mysql_stats_lag_lead LAG()/LEAD() window function summary, limit, compact
mysql_stats_running_total Running total window function summary, limit, compact
mysql_stats_moving_avg Moving average window function summary, limit, compact
mysql_stats_ntile NTILE() window function summary, limit, compact
mysql_stats_hypothesis T-Test/Chi-Square hypothesis testing summary, limit, compact
mysql_stats_outliers Z-Score/IQR outlier detection summary, limit, compact
mysql_stats_top_n Top N items per category summary, limit, compact
mysql_stats_distinct Count distinct values summary, limit, compact
mysql_stats_frequency Value frequency and mode summary, limit, compact
mysql_stats_summary Comprehensive numeric summary summary, limit, compact

Optimize Performance and Analytics (11 tools)

Tool Description Parameters
mysql_explain EXPLAIN query execution plan. v2.2: JSON/TREE/TRADITIONAL formats summary, limit, compact
mysql_explain_analyze EXPLAIN ANALYZE (MySQL 8.0) summary, limit, compact
mysql_slow_queries Query slow query log summary, limit, compact
mysql_query_stats Performance schema stats summary, limit, compact
mysql_index_usage Index usage statistics summary, limit, compact
mysql_table_stats Table statistics and health metrics summary, limit, compact
mysql_buffer_pool_stats InnoDB buffer pool info summary, limit, compact
mysql_thread_stats Thread activity stats summary, limit, compact
mysql_detect_query_anomalies Detect unusual query execution patterns summary, limit, compact
mysql_detect_bloat_risk Identify tables with high risk of fragmentation summary, limit, compact
mysql_detect_connection_spikes Detect connection pool anomalies summary, limit, compact

Execute Query Optimization (4 tools)

Tool Description Parameters
mysql_index_recommendation Suggest missing indexes. v3.2.2: Supports database-wide audit (empty payload allowed). summary, limit, compact
mysql_query_rewrite Query optimization hints summary, limit, compact
mysql_force_index Generate FORCE INDEX hints summary, limit, compact
mysql_optimizer_trace View optimizer decisions. v3.0.2: summary mode summary, limit, compact

Perform Administrative Actions (9 tools)

Tool Description Parameters
mysql_optimize_table OPTIMIZE TABLE summary, limit, compact
mysql_analyze_table ANALYZE TABLE statistics summary, limit, compact
mysql_check_table CHECK TABLE integrity summary, limit, compact
mysql_repair_table REPAIR TABLE (MyISAM) summary, limit, compact
mysql_flush_tables FLUSH TABLES summary, limit, compact
mysql_kill_query KILL connection/query summary, limit, compact
mysql_append_insight Append insight to log summary, limit, compact
mysql_server_config Manage server configs. v3.2.2: action parameter required summary, limit, compact
mysql_audit_search Search and filter system audit logs. v3.2.2: Fixed default limit. Security: requires at least one filter to prevent payload bloat. summary, limit, compact

Enforce Security and Compliance (9 tools)

Tool Description Parameters
mysql_security_audit Audit user privileges and settings summary, limit, compact
mysql_security_firewall_status Firewall status (Enterprise/MariaDB) summary, limit, compact
mysql_security_firewall_rules List firewall rules summary, limit, compact
mysql_security_mask_data Mask PII data patterns (with alias validation) summary, limit, compact
mysql_security_password_validate Check password strength policy summary, limit, compact
mysql_security_ssl_status SSL/TLS connection status summary, limit, compact
mysql_security_user_privileges List privileges for user. v3.0.2: summary mode summary, limit, compact
mysql_security_sensitive_tables Scan for sensitive table names summary, limit, compact
mysql_security_encryption_status TDE/Encryption-at-rest status summary, limit, compact

Manage User Roles and Privileges (8 tools)

MySQL 8.0+ Role Management

Tool Description Parameters
mysql_role_list List defined roles summary, limit, compact
mysql_role_create CREATE ROLE summary, limit, compact
mysql_role_drop DROP ROLE summary, limit, compact
mysql_role_grants SHOW GRANTS FOR role summary, limit, compact
mysql_role_grant GRANT privileges TO role summary, limit, compact
mysql_role_assign GRANT role TO user summary, limit, compact
mysql_role_revoke REVOKE role FROM user summary, limit, compact
mysql_user_roles List active roles for user summary, limit, compact

Monitor Server Health and Status (7 tools)

Tool Description Parameters
mysql_show_processlist SHOW PROCESSLIST summary, limit, compact
mysql_show_status SHOW STATUS variables summary, limit, compact
mysql_show_variables SHOW VARIABLES summary, limit, compact
mysql_innodb_status SHOW ENGINE INNODB STATUS. v3.0.2: summary mode summary, limit, compact
mysql_replication_status SHOW SLAVE STATUS summary, limit, compact
mysql_pool_stats Connection pool statistics summary, limit, compact
mysql_server_health Server health check summary, limit, compact

Leverage the sys Schema (8 tools)

Tool Description Parameters
mysql_sys_user_summary Resource usage by user. v3.2.2: Strict validation and aliases summary, limit, compact
mysql_sys_io_summary I/O usage by thread/file summary, limit, compact
mysql_sys_statement_summary Statement analysis summary, limit, compact
mysql_sys_wait_summary Wait events analysis summary, limit, compact
mysql_sys_innodb_lock_waits Blocked transactions info summary, limit, compact
mysql_sys_schema_stats Table/index sizes and bloat summary, limit, compact
mysql_sys_host_summary Metrics by source host. v3.2.2: Strict validation and aliases summary, limit, compact
mysql_sys_memory_summary Memory usage breakdown summary, limit, compact

Capture and Restore Backups (7 tools)

Tool Description Parameters
mysql_export_table Export table to SQL/CSV. v2.2: limit parameter (default: 5) summary, limit, compact
mysql_import_data LOAD DATA INFILE summary, limit, compact
mysql_create_dump mysqldump command generation summary, limit, compact
mysql_restore_dump Restore from dump summary, limit, compact
mysql_audit_list_backups List available snapshots summary, limit, compact
mysql_audit_restore_backup Restore a snapshot summary, limit, compact
mysql_audit_diff_backup Diff a snapshot summary, limit, compact

Monitor Replication Topology (5 tools)

Tool Description Parameters
mysql_master_status SHOW MASTER STATUS summary, limit, compact
mysql_slave_status SHOW SLAVE STATUS summary, limit, compact
mysql_binlog_events SHOW BINLOG EVENTS summary, limit, compact
mysql_gtid_status GTID_EXECUTED status summary, limit, compact
mysql_replication_lag Calculate replication lag summary, limit, compact

Manage InnoDB Clusters (10 tools)

Group Replication / InnoDB Cluster

Tool Description Parameters
mysql_gr_status Group Replication status summary, limit, compact
mysql_gr_members List cluster members summary, limit, compact
mysql_gr_primary Get/Set primary member summary, limit, compact
mysql_gr_transactions Check distributed transactions summary, limit, compact
mysql_gr_flow_control Tuning flow control summary, limit, compact
mysql_cluster_status InnoDB Cluster overall status. v3.0.2: summary mode summary, limit, compact
mysql_cluster_instances List instance details. v2.2: offline node reporting summary, limit, compact
mysql_cluster_topology View cluster topology map. v2.2: offline instance visibility summary, limit, compact
mysql_cluster_router_status Connected Routers. v3.0.2: summary mode summary, limit, compact
mysql_cluster_switchover Validates switchover readiness summary, limit, compact

Manage Table Partitioning (4 tools)

Tool Description Parameters
mysql_partition_info Partition information summary, limit, compact
mysql_add_partition ADD PARTITION summary, limit, compact
mysql_drop_partition DROP PARTITION summary, limit, compact
mysql_reorganize_partition REORGANIZE PARTITION summary, limit, compact

Control Scheduled Events (6 tools)

MySQL Event Scheduler

Tool Description Parameters
mysql_event_create CREATE EVENT summary, limit, compact
mysql_event_alter ALTER EVENT summary, limit, compact
mysql_event_drop DROP EVENT summary, limit, compact
mysql_event_list SHOW EVENTS (Active Control) summary, limit, compact
mysql_event_status Check event last run/status summary, limit, compact
mysql_scheduler_status Check if scheduler is ON/OFF summary, limit, compact

Integrate with MySQL Router (9 tools)

Note: Requires MySQL Router 8.0.17+ with REST API enabled. For InnoDB Cluster deployments, the cluster must be running for REST API authentication. See MySQL-Router.

Tool Description Parameters
mysql_router_status Get Router process status and version None
mysql_router_routes List all configured routes None
mysql_router_route_status Get status of a specific route routeName
mysql_router_route_health Check health/liveness of a route routeName
mysql_router_route_connections List active connections on route routeName
mysql_router_route_destinations List backend MySQL server destinations routeName
mysql_router_route_blocked_hosts List blocked IP addresses for a route routeName
mysql_router_metadata_status InnoDB Cluster metadata cache status ⚠️ metadataName (typically bootstrap)
mysql_router_pool_status Connection pool statistics ⚠️ poolName

⚠️ = Requires InnoDB Cluster


Integrate with ProxySQL (11 tools)

Note: Requires access to ProxySQL admin interface. See ProxySQL.

Tool Description Parameters
proxysql_status Get ProxySQL version, uptime, and runtime stats. v3.0.2: summary mode summary, limit, compact
proxysql_servers List configured backend MySQL servers summary, limit, compact
proxysql_query_rules List query routing rules summary, limit, compact
proxysql_query_digest Get query digest statistics (top queries) summary, limit, compact
proxysql_connection_pool Get connection pool statistics per server summary, limit, compact
proxysql_users List configured MySQL users summary, limit, compact
proxysql_global_variables Get global variables (mysql-* and admin-*). v3.0.2: limit, like params; credential redaction summary, limit, compact
proxysql_runtime_status Get runtime configuration status. v3.0.2: summary mode; credential redaction summary, limit, compact
proxysql_memory_stats Get memory usage metrics summary, limit, compact
proxysql_commands Execute LOAD/SAVE admin commands summary, limit, compact
proxysql_process_list Get active sessions summary, limit, compact

Utilize MySQL Shell Integration (10 tools)

Note: Requires MySQL Shell 8.0+ installed. See MySQL-Shell.

Tool Description Parameters
mysqlsh_version Get MySQL Shell version and installation status summary, limit, compact
mysqlsh_check_upgrade Check server upgrade compatibility summary, limit, compact
mysqlsh_export_table Export table to file (CSV, TSV) summary, limit, compact
mysqlsh_import_table Parallel table import. v2.1: updateServerSettings auto-enables local_infile summary, limit, compact
mysqlsh_import_json Import JSON documents to collection or table summary, limit, compact
mysqlsh_dump_instance Dump entire MySQL instance summary, limit, compact
mysqlsh_dump_schemas Dump selected schemas. v2.1: ddlOnly dumps only DDL summary, limit, compact
mysqlsh_dump_tables Dump specific tables. v2.1: all controls trigger inclusion summary, limit, compact
mysqlsh_load_dump Load MySQL Shell dump. v2.1: updateServerSettings auto-enables local_infile summary, limit, compact
mysqlsh_run_script Execute JS/Python/SQL script via MySQL Shell summary, limit, compact

Perform Vector Search Operations (11 tools)

Vector embeddings, KNN search, and hybrid search (MySQL 9.0+)

Tool Description Parameters
mysql_vector_store Store a single vector embedding summary, limit, compact
mysql_vector_batch_store Bulk insert vector embeddings summary, limit, compact
mysql_vector_delete Delete a vector by primary key summary, limit, compact
mysql_vector_get Retrieve a vector by primary key summary, limit, compact
mysql_vector_search Top-k nearest neighbors (KNN) search summary, limit, compact
mysql_vector_range_search Find all vectors within a distance threshold summary, limit, compact
mysql_vector_hybrid_search Combine vector distance with FULLTEXT relevance using Reciprocal Rank Fusion. v3.1: metric, rrfK, select, filter parameters summary, limit, compact
mysql_vector_info View table vector columns and dimensions summary, limit, compact
mysql_vector_create_index Create HNSW vector index (MySQL 9.1+) summary, limit, compact
mysql_vector_optimize Optimize vector index statistics summary, limit, compact
mysql_vector_stats Get vector dimension, count, and distance statistics summary, limit, compact

Execute Schema Introspection (6 tools)

Pre-flight analysis, relationship mapping, and constraint validation tools to ensure schema modifications are safe.

Tool Description Parameters
mysql_dependency_graph Generate a deep relationship graph of tables based on foreign keys summary, limit, compact
mysql_topological_sort Determine exact creation/deletion order for foreign key constraints summary, limit, compact
mysql_cascade_simulator Simulate cascading deletes/updates without actual data modification summary, limit, compact
mysql_schema_snapshot Capture the state of the schema definition at a given point in time summary, limit, compact
mysql_constraint_analysis Detect circular dependencies, missing indexes, and overlapping constraints summary, limit, compact
mysql_migration_risks Run pre-flight checks on DDL to identify downtime or locking risks summary, limit, compact

Manage Database Migrations (6 tools)

Integrated schema versioning and deployment tracker built directly into the MCP server.

Tool Description Parameters
mysql_migration_init Set up migration tracking tables in the database summary, limit, compact
mysql_migration_record Manually record an out-of-band migration to the history summary, limit, compact
mysql_migration_apply Apply a single forward migration step summary, limit, compact
mysql_migration_rollback Revert a recently applied migration summary, limit, compact
mysql_migration_history View applied migrations history summary, limit, compact
mysql_migration_status Check the current state of applied vs. pending migrations summary, limit, compact

Code Mode (1 tool)

Execute JavaScript in an isolated-vm sandbox with access to all MySQL tools via mysql.* API. See Code-Mode for full API documentation. Configure CODE_MODE_MAX_RESULT_SIZE max result payload (default 102400) and METADATA_CACHE_TTL_MS cache TTL (default 30000).

Tool Description Parameters
mysql_execute_code Code Mode (mysql_execute_code) dramatically reduces token usage (70–90%). Execute code with access to all mysql.* APIs. Params: code, timeout, readonly. summary, limit, compact

Expand Your Knowledge (See Also)


Updated for v3.2.2 — July 5, 2026

MySQL MCP Documentation

Unlock autonomous database orchestration with an enterprise-grade MySQL MCP server. Featuring blazing-fast sandboxed Code Mode, uncompromising schema enforcement, and seamless ecosystem integrations to power secure, intelligent AI workflows.

🏠 Home


Launch Your Setup


Connect Ecosystem Tools


Enforce Security & Compliance


Scale Your Operations


Explore External Links

Clone this wiki locally