Designcomputer Mysql MCP Server

🚀 MySQL MCP Server

A server compliant with 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, allowing for safer exploration and analysis of the database.

✨ Features

• List available MySQL tables as resources.
• Read the contents of message tables.
• Execute SQL queries with error handling.
• Implement secure control of database access via environment variables.
• Provide comprehensive logging.

📦 Installation

pip install mysql-mcp-server

📚 Configuration

Set the following environment variables:

MYSQL_HOST=localhost
MYSQL_USER=your_username
MYSQL_PASSWORD=your_password
MYSQL_DATABASE=your_database

💻 Usage Examples

Basic Usage - Integration with Claude Desktop

Add the following content to the claude_desktop_config.json file:

{
  "mcpServers": {
    "mysql": {
      "command": "uv",
      "args": [
        "--directory", 
        "path/to/mysql_mcp_server",
        "run",
        "mysql_mcp_server"
      ],
      "env": {
        "MYSQL_HOST": "localhost",
        "MYSQL_USER": "your_username",
        "MYSQL_PASSWORD": "your_password",
        "MYSQL_DATABASE": "your_database"
      }
    }
  }
}

Advanced Usage - Running as an Independent Server

# Install dependencies
pip install -r requirements.txt

# Run the server
python -m mysql_mcp_server

🛠️ Development

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

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

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

# Run tests
pytest

⚠️ Important Note

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

💡 Usage Tip

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

1. Create a dedicated MySQL user with minimal privileges.
2. Avoid using the root account or administrative accounts.
3. Restrict database access to only necessary operations.
4. Enable logging for auditing purposes.
5. Conduct regular security reviews of database access.

Refer to the MySQL Security Configuration Guide for more detailed instructions, including:

• Creating a restricted MySQL user.
• Setting appropriate permissions.
• Monitoring database access.
• Other security best practices.

⚠️ Important Note

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

📄 License

MIT License - See the LICENSE file for details.

🤝 Contribution

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.