Mysql

🚀 MySQL MCP Server

A server implementing the Model Context Protocol (MCP) for secure interaction with MySQL databases. This server enables AI assistants to list tables, read data, and execute SQL queries through a controlled interface, making database exploration and analysis more secure and structured.

🚀 Quick Start

This server allows you to securely interact with MySQL databases. Here's how to get started.

✨ Features

• List available MySQL tables as resources.
• Read table contents.
• Execute SQL queries with appropriate error handling.
• Ensure database access security through environment variables.
• Provide comprehensive logging.

📦 Installation

Set the following environment variables:

MYSQL_HOST=localhost     # Database host
MYSQL_PORT=3306         # Optional: Database port (default is 3306 if not specified)
MYSQL_USER=your_username
MYSQL_PASSWORD=your_password
MYSQL_DATABASE=your_database

💻 Usage Examples

Basic Usage

Use with Claude Desktop

Add the following to claude_desktop_config.json:

{
  "mcpServers": {
    "mysql": {
      "command": "python",
      "args": [
        "-m", 
        "src.mysql_mcp_server.server"
      ],
      "env": {
        "MYSQL_HOST": "localhost",
        "MYSQL_PORT": "3306",
        "MYSQL_USER": "your_username",
        "MYSQL_PASSWORD": "your_password",
        "MYSQL_DATABASE": "your_database"
      }
    }
  }
}

Run as a Stand - Alone Server

# Clone the repository
git clone https://github.com/designcomputer/mysql_mcp_server.git
cd mysql_mcp_server

# Install dependencies
pip install -r requirements.txt

# Run the server
python -m src.mysql_mcp_server.server

Advanced Usage

Development

# Clone the repository
git clone https://github.com/designcomputer/mysql_mcp_server.git
cd mysql_mcp_server

# Create a virtual environment
python -m venv py-mcp-mysql_venv
source py-mcp-mysql_venv/bin/activate  # or `py-mcp-mysql_venv\Scripts\activate` on Windows

# Install development dependencies
pip install -r requirements-dev.txt

# Run tests
pytest

📚 Documentation

Security Considerations

• Never commit environment variables or credentials.
• Use a database user with the minimum required privileges.
• Consider implementing a query whitelist in a production environment.
• Monitor and log all database operations.

Security Best Practices

This MCP server requires database access to run. For security reasons:

1. Create a dedicated MySQL user and grant minimal privileges.
2. Do not use root credentials or administrative accounts.
3. Limit database access to only necessary operations.
4. Enable logging for auditing.
5. Conduct regular security reviews to check database access.

See the MySQL Security Configuration Guide for detailed instructions on:

• Creating a restricted MySQL user.
• Setting appropriate privileges.
• Monitoring database access.
• Security best practices.

⚠️ Important Note

Always follow the principle of least privilege when configuring database access.

📄 License

This project is under the MIT License - see the LICENSE file for details.

🤝 Contribution Guidelines

1. Fork the repository.
2. Create a feature branch (git checkout -b feature/amazing-feature).
3. Commit your changes (git commit -m 'Add some amazing feature').
4. Push to the branch (git push origin feature/amazing-feature).
5. Open a Pull Request.