Go MCP Mysql

🚀 零負擔、即用型模型上下文協議（MCP）服務器

本項目是一個零負擔、即用型的模型上下文協議（MCP）服務器，主要用於與 MySQL 進行交互和自動化操作。無需 Node.js 或 Python 環境，就能輕鬆使用。此服務器提供了一系列工具，可對 MySQL 數據庫和表執行 CRUD 操作，還具備只讀模式，能有效防止意外的寫入操作。此外，您還可以通過添加 --with-explain-check 標誌，在執行查詢前使用 EXPLAIN 語句來檢查查詢計劃。

不過要注意，這是一個正在開發中的項目，目前可能還不適合用於生產環境。

🚀 快速開始

安裝

1. 您可以下載最新發佈版本，並將其放置在 $PATH 中，或者放在您方便訪問的位置。
2. 若您已經安裝了 Go，也可以從源代碼進行構建：

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

使用方法

方法 A：使用命令行參數

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

方法 B：使用帶自定義選項的 DSN

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

更多詳細信息請參閱MySQL DSN。

⚠️ 重要提示 若將二進制文件放在不在 $PATH 中的位置，需要用完整路徑替換 go-mcp-mysql。例如：若您將二進制文件放在下載文件夾中，則可以使用以下路徑：

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

可選標誌

• 添加 --read-only 標誌可啟用只讀模式。在此模式下，僅允許以 list、read_ 和 desc_ 開頭的工具使用。請確保在添加此標誌後刷新/重新啟動。
• 啟用檢查查詢計劃功能，方法是在執行查詢之前使用 EXPLAIN 語句：

# 檢查單條查詢
go-mcp-mysql --dsn "root:password@tcp(localhost:3306)/test" --with-explain -sql "SELECT * FROM user"

# 啟用檢查所有查詢
export GMCP_CHECK_QUERY=true

✨ 主要特性

工具

Schema Tools

mysql-backup

• 功能：備份指定數據庫的所有表結構。
• 參數：
  • --src-dsn：源數據庫連接字符串（必填）。
  • --dest-filename：輸出文件名，格式為 {db}_{table}.sql（可選，默認為 stdout）。
• 示例：

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

Data Tools

mysql-import

• 功能：將 SQL 文件導入到指定數據庫。
• 參數：
  • --dsn：數據庫連接字符串（必填）。
  • --filename：輸入文件路徑（必填）。
• 示例：

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

mysql-export

• 功能：將指定數據庫的所有表導出為 SQL 文件。
• 參數：
  • --src-dsn：源數據庫連接字符串（必填）。
  • --dest-filename：輸出文件名，格式為 {db}_{table}.sql（可選，默認為 stdout）。
• 示例：

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

📄 許可證

該項目採用 MIT 許可證。