MySQL MCP Xu

Project Overview

MySQL MCP Xu is a MySQL MCP Server project based on FastMCP, providing a secure and efficient interface for executing SQL operations. The project supports multiple permission controls (read, write, admin) and implements functions such as table structure queries, index information retrieval, and health status monitoring through utility functions.

Directory Structure

plaintext
.
├── src
│ └── mysql_mcp_xu
│ ├── init.py
│ ├── config.py
│ └── mcp_server.py
├── README.md
└── pyproject.toml

Quick Start

1. Install: pip install mysql-mcp-xu
2. Create a .env file in the directory where you will run the command, with the following content:
   bash
   MYSQL_HOST=localhost
   MYSQL_PORT=3306
   MYSQL_USER=your_username
   MYSQL_PASSWORD=your_password
   MYSQL_DATABASE=your_database

Possible values: r, w, a

MYSQL_ROLE=r

1. Start the command:
   • STDIO: uv run -m mysql_mcp_xu.mcp_server
   • Streamable HTTP: uv run -m mysql_mcp_xu.mcp_server sh
   • SSE: uv run -m mysql_mcp_xu.mcp_server sse
2. Connect to the service using an MCP client and execute SQL operations.

Features

• SQL Execution: Supports executing multiple SQL statements and returning results.
• Permission Control: Restricts SQL operations based on roles (read, write, admin).
• Table Structure Query: Retrieves field names, field comments, etc., for a specified table.
• Index Information Retrieval: Retrieves index names, index fields, index types, etc., for a specified table.
• Health Status Monitoring: Retrieves the health status of MySQL, including connection count, query count, buffer pool usage, etc.

Permission Control

Permission control is implemented via the PERMISSIONS dictionary, supporting the following roles:

• r: Read-only permission, allowing SELECT, SHOW, DESCRIBE, EXPLAIN, USE operations.
• w: Read-write permission, allowing SELECT, SHOW, DESCRIBE, EXPLAIN, INSERT, UPDATE, DELETE, USE operations.
• a: Admin permission, allowing all operations, including CREATE, ALTER, DROP, TRUNCATE, etc.

Utility Functions

• execute_sql: Executes an SQL statement and returns the result.
• get_table_structure: Retrieves field information for a specified table.
• get_table_indexes: Retrieves index information for a specified table.
• search_table_by_chinese: Searches for the corresponding table name in the database by Chinese table name or table description.
• get_mysql_health: Retrieves the health status of MySQL.

Deployment Methods

Using uvx for Deployment

Add the following configuration to the MCP configuration file to deploy the MySQL MCP Xu service using uvx:

STDIO

json
{
"mcpServers": {
"mysql-mcp-xu": {
"command": "uvx",
"args": [
"mysql-mcp-xu"
],
"env": {
"MYSQL_DATABASE": "",
"MYSQL_HOST": "",
"MYSQL_PASSWORD": "",
"MYSQL_PORT": "3306",
"MYSQL_ROLE": "r",
"MYSQL_USER": ""
}
}
}
}

Streamable HTTP

json
{
"mcpServers": {
"mysql-mcp-xu": {
"name": "mysql-mcp-xu",
"type": "streamableHttp",
"description": "",
"isActive": true,
"baseUrl": "http://localhost:9009/mcp"
}
}
}

SSE

json
{
"mcpServers": {
"mysql-mcp-xu": {
"name": "mysql-mcp-xu",
"description": "",
"isActive": true,
"baseUrl": "http://localhost:9009/sse"
}
}
}

Using uv for Deployment

json
{
"mcpServers": {
"mysql-mcp-xu": {
"command": "uv",
"args": [
"--directory",
"D:/mysql-mcp-xu/src/mysql_mcp_xu",
"run",
"-m",
"mcp_server"
]
}
}
}

Streamable HTTP

json
{
"mcpServers": {
"mysql-mcp-xu": {
"command": "uv",
"args": [
"--directory",
"D:/mysql-mcp-xu/src/mysql_mcp_xu",
"run",
"-m",
"mcp_server",
"sh"
]
}
}
}#### sse
json
{
"mcpServers": {
"mysql-mcp-xu": {
"command": "uv",
"args": [
"--directory",
"D:/mysql-mcp-xu/src/mysql_mcp_xu",
"run",
"-m",
"mcp_server",
"sse"
]
}
}
}