Mysql_mcp_server

38 forks

131 stars

Free

What is mysql_mcp_server

mysql_mcp_server is a specialized server developed by designcomputer that leverages the Model Context Protocol (MCP) to facilitate secure and structured interactions with MySQL databases. This server acts as an intermediary, enabling AI systems to safely explore, analyze, and interact with databases by listing tables, reading data, and executing SQL queries. The server ensures that these operations are conducted through a controlled and secure interface, making it a valuable tool for AI-driven data analysis and management.

How to Use mysql_mcp_server

To use mysql_mcp_server, follow these steps:

Installation: Begin by installing the server using the following command:
```
pip install mysql-mcp-server
```

Configuration: Set up the necessary environment variables to configure database access:

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

Running the Server:
- Standalone Mode: Install dependencies and run the server:
```
pip install -r requirements.txt
python -m mysql_mcp_server
```
- Integration with Claude Desktop: Add the server details to your claude_desktop_config.json to integrate it with Claude Desktop applications.

Key Features of mysql_mcp_server

Table Listing and Data Reading: The server enables AI systems to list available MySQL tables and read their contents securely, facilitating data exploration.
SQL Query Execution: Execute SQL queries with robust error handling, ensuring operations are both effective and safe.
Secure Access: Utilizes environment variables for secure database access, minimizing the risk of exposing sensitive credentials.
Comprehensive Logging: Maintains detailed logs of all operations, providing an audit trail for security and troubleshooting purposes.
Best Security Practices: Encourages the use of minimal permissions for database users and recommends enabling logging and regular security reviews to maintain a secure environment.

mysql_mcp_server is designed with security and ease of use in mind, making it an ideal choice for integrating MySQL database functionality with AI systems. Whether used standalone or as part of a larger AI suite, it facilitates a seamless and secure connection to your data resources.

Tests

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, making database exploration and analysis safer and more structured.

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

pip install mysql-mcp-server

Configuration

Set the following environment variables:

MYSQL_HOST=localhost # Database host
MYSQL_PORT=3306 # Optional: Database port (defaults to 3306 if not specified)
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 
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
Consider implementing query whitelisting for production use
Monitor and log all database operations

Security Best Practices

This MCP server requires database access to function. For security:

Create a dedicated MySQL user with minimal permissions
Never use root credentials or administrative accounts
Restrict database access to only necessary operations
Enable logging for audit purposes
Regular security reviews of database access See MySQL Security Configuration Guide for detailed instructions on:

Creating a restricted MySQL user
Setting appropriate permissions
Monitoring database access
Security best practices ⚠️ IMPORTANT: Always follow the principle of least privilege when configuring database access.

License

MIT License - see LICENSE file for details.

Contributing

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

How to Use

To use the mysql_mcp_server, follow these steps:

Visit https://github.com/designcomputer/mysql_mcp_serverhttps://github.com/design...
Follow the setup instructions to create an account (if required)
Connect the MCP server to your Claude Desktop application
Start using mysql_mcp_server capabilities within your Claude conversations

Additional Information

Created

December 3, 2024

Company

designcomputer

Related MCP Servers

Start building your own MCP Server

Interested in creating your own MCP Server? Check out the official documentation and resources.

Learn More