MCP Mysql Server

🚀 mcp-mysql-server

A MySQL database operation server based on the Model Context Protocol (MCP). This server enables AI models to interact with MySQL databases through a standardized interface.

🚀 Quick Start

📦 Installation

npx @malove86/mcp-mysql-server

⚙️ Configuration

The server supports two deployment modes:

1. Local Running Mode

Run it using the command line in the MCP settings configuration file:

{
  "mcpServers": {
    "mysql": {
      "command": "npx",
      "args": ["-y", "@malove86/mcp-mysql-server"],
      "env": {
        "MYSQL_HOST": "your_host",
        "MYSQL_USER": "your_user",
        "MYSQL_PASSWORD": "your_password",
        "MYSQL_DATABASE": "your_database",
        "MYSQL_PORT": "3306"
      }
    }
  }
}

2. Remote URL Mode (v0.2.2+)

Point to a remotely running MCP server:

{
  "mcpServers": {
    "mcp-mysql-server": {
      "url": "http://your-server-address:port/mcp-mysql-server"
    }
  }
}

On the remote server, you need to set environment variables and then start the MCP server:

# Set environment variables
export MYSQL_HOST=your_host
export MYSQL_USER=your_user
export MYSQL_PASSWORD=your_password
export MYSQL_DATABASE=your_database
export MYSQL_PORT=3306  # Optional, default is 3306

# Start the server
npx @malove86/mcp-mysql-server

⚠️ Important Note

MYSQL_PORT is optional, and the default value is 3306.

✨ Features

New Features in v0.2.4+

• Multi-user Concurrency Support: The server can now handle requests from multiple users simultaneously.
• Efficient Connection Pool Management: An improved connection pool is used, supporting up to 50 concurrent connections.
• Request-level Isolation: Each request has a unique identifier for easy tracking and debugging.
• Detailed Logging: Records the execution process and resource usage of each request.
• Improved Error Handling: More accurately captures and reports database errors.
• Performance Optimization: Connection pool reuse and optimized connection management improve processing speed.

New Features in v0.2.3+

• Initial Version: Provides basic functions, including database connection and query execution.

💻 Usage Examples

Available Tools

The following are the main tools provided by the server:

1. connect_db

Used to establish a database connection.

{
  "tool": "connect_db",
  "params": {
    "host": "localhost",
    "user": "root",
    "password": "password",
    "database": "mydb"
  }
}

2. query

Execute a database query.

{
  "tool": "query",
  "params": {
    "sql": "SELECT * FROM users LIMIT 10"
  }
}

3. list_tables

List all tables in the database.

{
  "tool": "list_tables",
  "params": {}
}

4. describe_table

Describe the structure of a specified table.

{
  "tool": "describe_table",
  "params": {
    "table_name": "users"
  }
}

🔧 Technical Details

Feature Highlights

• High Performance: Optimizes database connections and query execution to improve processing speed.
• High Availability: Supports concurrent access by multiple users to ensure service stability.
• Security: Manages sensitive information through environment variables to prevent data leakage.
• Scalability: Supports the remote URL mode for easy deployment and management.

Performance

• Maximum concurrent connections: 50
• Supports efficient database operations to improve overall performance

Security

• User Isolation: Ensures data independence between different users to prevent cross-contamination.
• SQL Injection Prevention: Avoids security vulnerabilities through parameterized queries.
• Permission Management: Restricts access permissions to safeguard data security.

🤝 Contribution

Contributions are welcome! Please feel free to submit a Pull Request to https://github.com/Malove86/mcp-mysql-server.git

📄 License

MIT