Mysql MCP Servers

🚀 MySQL MCP Server

This project provides a server for interacting with MySQL databases using the Model Context Protocol (MCP). It offers an interface for MySQL databases in the WSL environment.

✨ Features

• Retrieve a list of tables in the MySQL database.
• Read data from tables (up to 100 rows).
• Execute SQL queries (supporting SELECT, SHOW TABLES, INSERT, UPDATE, DELETE, etc.).

📁 Project Structure

src/mysql_mcp_server/
├── __init__.py        # Package initialization file
├── config/           # Configuration-related module
│   ├── __init__.py  
│   └── settings.py   # Database configuration
├── database/         # Database operation module
│   ├── __init__.py  
│   ├── connection.py # Database connection handling
│   └── errors.py     # Error classes
├── tools/            # Tool module
│   ├── __init__.py  
│   └── sql_tools.py  # SQL execution tools
└── server.py         # Main file of the MCP server

📦 Installation and Running

Prerequisites

• Python 3.11 or higher.
• MySQL server (local or remote).
• Virtual environment (virtualenv).
• Docker (when using Docker).

Setup

1. Clone the repository:

   git clone <repository-url>
   cd mysql_mcp_server
   

2. Create and activate a virtual environment:

   python -m venv .venv
   source .venv/bin/activate  # For Linux systems
   

3. Install dependencies:

   pip install -r requirements.txt .
   

4. Run the setup script to grant execution permissions and run:

   chmod +x setup.sh
   ./setup.sh
   

Running Methods

You can run the server in any of the following ways:

1. Run Directly

./run_direct.sh

2. Run as a Module

./run_module.sh

3. Run Using a Docker Container

# Build the Docker image
docker build -t mysql-mcp-server:latest .

# Run the container
./run_docker.sh

⚙️ Environment Variables

The server uses the following environment variables to connect to MySQL:

• MYSQL_HOST: The host of the MySQL server (default: host.docker.internal).
• MYSQL_PORT: The port of the MySQL server (default: 13306).
• MYSQL_USER: The MySQL username.
• MYSQL_PASSWORD: The MySQL password.
• MYSQL_DATABASE: The name of the database to use.

📡 MCP Protocol

This server implements the MCP protocol and provides the following endpoints:

• list_resources: Retrieve a list of tables in the database.
• read_resource: Read data from a specific table.
• list_tools: List available tools.
• execute_query: Execute SQL queries.

⚠️ Notes for WSL Environment

When running in the WSL environment, pay attention to file paths and network configurations. Refer to the WSL section in the documentation for more information.

🧪 Testing

Run Tests Using Nox

1. Install Nox:

   pip install nox
   

2. Run all tests:

   nox -s test
   

3. Format the code:

   nox -s format
   

4. Perform code checks:

   nox -s lint
   

Run Tests Directly

pytest tests/

Check Code Coverage

pytest --cov=src.mysql_mcp_server tests/

📄 License

This project is open-source under the MIT License.