Mysql MCP Server Qrx

🚀 Read-only Model Context Protocol (MCP) Server

This project offers a read-only Model Context Protocol (MCP) server for interacting with MySQL and PostgreSQL databases. It enables MCP-compatible clients to inspect database schemas, retrieve metadata, and execute read-only SQL queries through a set of defined tools. The server is scalable and enforces read-only operations for security.

🚀 Quick Start

This project provides a read - only Model Context Protocol (MCP) server that interacts with MySQL and PostgreSQL databases. It allows MCP - compatible clients to inspect database schemas, retrieve metadata, and execute read - only SQL queries via a set of defined tools. The server is scalable and enforces read - only operations to ensure security.

✨ Features

Schema and Metadata Tools

• get_table_columns: Get column definitions for a specific table.
• get_schema: Retrieve detailed schema information, including tables, columns, indexes, and constraints, with different levels of detail.
• get_indexes: Get index information for a specific table or all tables.
• get_constraints: Retrieve constraint information (primary keys, foreign keys, unique, check) for a specific table or all tables.
• compare_schemas: Compare the structures (tables and columns) of two different database schemas.
• explain_schema: Generate a text - based or structured (JSON) description of the database schema.
• detect_schema_changes: Return a snapshot of the current schema. (Note: Does not compare with a specific past time).
• find_relationships: Discover explicit foreign - key relationships. Optionally, try to discover implicit relationships based on naming conventions (use with caution).
• find_navigation_paths: Use explicit foreign - key relationships to find paths between two tables via a breadth - first search algorithm.

Query Execution Tools

• execute_query: Execute a given read - only SQL query (SELECT, SHOW, DESCRIBE, EXPLAIN).
• execute_batch: Run multiple read - only SQL queries sequentially. Can stop at the first error or attempt all.
• prepare_statement: Prepare and execute a read - only SQL statement with parameters.
• explain_query: Execute EXPLAIN on a given SQL statement to show the query execution plan (text or JSON format).
• get_query_history: Placeholder tool. Server - side query history is not yet implemented.

Visualization Tools

• visualize_schema: Generate a schema representation (tables, columns, relationships) in JSON, DOT (Graphviz), or Mermaid syntax for creating ER diagrams.

Performance Tools

• get_performance_metrics: Retrieve selected global status variables from MySQL (e.g., uptime, threads, queries). Does not provide specific query history.

📦 Installation

Prerequisites

• Node.js
• npm
• Access to a MySQL or PostgreSQL database

Steps

1. Clone the repository:

git clone https://github.com/kaulvimal/mysql-mcp
cd mysql-mcp

2. Install dependencies:

npm install

3. Build the project:

npm run build

This will create a build directory containing the compiled code.

4. Use the server Create a shell script (e.g., mysql-mcp.sh) in the project root directory or a convenient location:

#!/bin/bash
# Set environment variables (if you don't want to use.env file or want to override)
export MYSQL_HOST=""
export MYSQL_USER=""