Go MCP Mysql

🚀 Zero-Burden, Ready-to-Use Model Context Protocol (MCP) Server for MySQL Interaction and Automation

This is a zero-burden, ready-to-use Model Context Protocol (MCP) server designed for interacting with MySQL databases and automating related tasks. It doesn't require a Node.js or Python environment. The server offers tools to perform CRUD operations on MySQL databases and tables, and provides a read-only mode to prevent accidental write operations. You can also enable the function to check query plans by using the EXPLAIN statement before executing queries, which can be achieved by adding the --with-explain-check flag.

Please note that this is an ongoing project and may not be ready for production use.

🚀 Quick Start

📦 Installation

1. Download the latest release and place it in your $PATH or a location that you can easily access.
2. Alternatively, if you have Go installed, you can build it from the source code:

go install -v github.com/Zhwt/go-mcp-mysql@latest

💻 Usage Examples

Basic Usage

There are two ways to use the server:

Method A: Using Command-Line Arguments

{
  "mcpServers": {
    "mysql": {
      "command": "go-mcp-mysql",
      "args": [
        "--host", "localhost",
        "--user", "root",
        "--pass", "password",
        "--port", "3306",
        "--db", "mydb"
      ]
    }
  }
}

Method B: Using DSN with Custom Options

{
  "mcpServers": {
    "mysql": {
      "command": "go-mcp-mysql",
      "args": [
        "--dsn", "username:password@tcp(localhost:3306)/mydb?parseTime=true&loc=Local"
      ]
    }
  }
}

Refer to MySQL DSN for more details.

Note: If you place the binary file in a location that is not in your $PATH, you need to replace go-mcp-mysql with the full path. For example, if you place the binary file in the Downloads folder, you can use the following path:

{
  "mcpServers": {
    "mysql": {
      "command": "C:\\Users\\<username>\\Downloads\\go-mcp-mysql.exe",
      "args": [
        ...
      ]
    }
  }
}

Advanced Usage

Optional Flags

• Add the --read-only flag to enable read-only mode. In this mode, only tools starting with list, read_, and desc_ are allowed. Make sure to refresh/restart after adding this flag.
• Enable the function to check query plans by using the EXPLAIN statement before executing queries:

# Check a single query
go-mcp-mysql --dsn "root:password@tcp(localhost:3306)/test" --with-explain -sql "SELECT * FROM user"

# Enable checking all queries
export GMCP_CHECK_QUERY=true

Tools

Schema Tools

mysql-backup

• Function: Backup all table structures of a specified database.
• Parameters:
  • --src-dsn: Source database connection string (required).
  • --dest-filename: Output file name in the format of {db}_{table}.sql (optional, default is stdout).
• Example:

mysql-backup --src-dsn "root:password@tcp(localhost:3306)/test"

Data Tools

mysql-import

• Function: Import an SQL file into a specified database.
• Parameters:
  • --dsn: Database connection string (required).
  • --filename: Input file path (required).
• Example:

mysql-import --dsn "root:password@tcp(localhost:3306)/test" --filename user.sql

mysql-export

• Function: Export all tables of a specified database as SQL files.
• Parameters:
  • --src-dsn: Source database connection string (required).
  • --dest-filename: Output file name in the format of {db}_{table}.sql (optional, default is stdout).
• Example:

mysql-export --src-dsn "root:password@tcp(localhost:3306)/test"

📄 License

This project is licensed under the MIT License.