MCP HubMCP Hub
designcomputer

mysql_mcp_server

by: designcomputer

A Model Context Protocol (MCP) server that enables secure interaction with MySQL databases

333created 03/12/2024
Visit
MySQL
security

📌Overview

Purpose: To provide a secure Model Context Protocol (MCP) server facilitating efficient and safe interactions with MySQL databases for AI assistants.

Overview: The MySQL MCP Server serves as a controlled interface for AI assistants, enabling them to interact with MySQL databases. It simplifies database exploration, making it safer and more structured by allowing listing of tables, reading data, and executing SQL queries with secure access controls.

Key Features:

  • List Tables: Allows the server to list available MySQL tables as resources, aiding in navigation and selection of data.

  • SQL Query Execution: Facilitates execution of SQL queries with robust error handling, ensuring safe operations and preventing accidental data manipulation.

  • Secure Access: Utilizes environment variables to ensure secure database access, protecting sensitive credentials.

  • Comprehensive Logging: Implements thorough logging of operations for transparency and audit purposes, enhancing security and monitoring capabilities.


MySQL MCP Server

A Model Context Protocol (MCP) server that enables secure interaction with MySQL databases. This server allows AI assistants to list tables, read data, and execute SQL queries through a controlled interface.

Features

  • List available MySQL tables as resources
  • Read table contents
  • Execute SQL queries with proper error handling
  • Secure database access through environment variables
  • Comprehensive logging

Installation

Manual Installation

pip install mysql-mcp-server

Installing via Smithery

To install MySQL Server for Claude Desktop automatically via Smithery:

npx -y @smithery/cli install mysql-mcp-server --client claude

Configuration

Set the following environment variables:

MYSQL_HOST=localhost     # Database host
MYSQL_PORT=3306         # Optional: Database port
MYSQL_USER=your_username
MYSQL_PASSWORD=your_password
MYSQL_DATABASE=your_database

Usage

With Claude Desktop

Add this to your claude_desktop_config.json:

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

As a standalone 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 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

Security Considerations

  • Never commit environment variables or credentials.
  • Use a database user with minimal required permissions.
  • Monitor and log all database operations.

Security Best Practices

  1. Create a dedicated MySQL user with minimal permissions.
  2. Never use root credentials or administrative accounts.
  3. Restrict database access to only necessary operations.
  4. Enable logging for audit purposes.
  5. Conduct regular security reviews of database access.

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

License

MIT License - see LICENSE file for details.

Contributing

  1. Fork the repository.
  2. Create your 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.