Mysql MCP Server

🚀 MySQL MCP Server

A MySQL implementation of the Model Context Protocol (MCP), enabling secure interaction between AI applications and MySQL databases. This server component facilitates communication between AI applications (hosts/clients) and MySQL databases through a controlled interface, making database exploration and analysis more secure and structured.

⚠️ Important Note

The MySQL MCP Server is not designed to run as a standalone server. Instead, it serves as an implementation component for the communication protocol between AI applications and MySQL databases.

✨ Features

• List available MySQL tables as resources.
• Read table contents.
• Execute SQL queries with error handling.
• Enable secure database access via environment variables.
• Provide comprehensive logging.

📦 Installation

Manual Installation

pip install mysql-mcp-server

Installation via Smithery

Automatically install the MySQL MCP Server for Claude Desktop using 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 (default is 3306 if not specified)
MYSQL_USER=your_username
MYSQL_PASSWORD=your_password
MYSQL_DATABASE=your_database

💻 Usage Examples

Usage in Claude Desktop

Add the following content to claude_desktop_config.json:

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

Usage in Visual Studio Code

Configure the launch.json file to support debugging:

{
  "version": "0.2.0",
  "configurations": [
    {
      "name": "Start MySQL MCP Server",
      "type": "python",
      "request": "launch",
      "program": "path/to/mysql_mcp_server/__main__.py",
      "args": []
    }
  ]
}

🛠️ Development

To contribute to the project, follow these steps:

1. Clone the repository: git clone https://github.com/yourusername/mysql-mcp-server.git
2. Install dependencies: pip install -r requirements.txt
3. Start the test environment: pytest tests/

⚠️ Security Precautions

• Never commit environment variables or credentials to the version control system.
• Protect database connections using HTTPS.
• Regularly update database credentials.

💡 Usage Tip

• Avoid exposing database ports in the production environment.
• Use firewalls to restrict database access.
• Configure audit logs to monitor sensitive operations.

📄 License

This project is licensed under the MIT License.

🤝 Contribution Guidelines

1. Clone the repository: git clone https://github.com/yourusername/mysql-mcp-server.git
2. Create a feature branch: git checkout -b feature/amazing-feature
3. Commit your changes: git commit -m 'Implement amazing new feature'
4. Push to the branch: git push origin feature/amazing-feature
5. Submit a pull request.

By following these steps, you can make valuable contributions to the project's development.