Mysql MCP Server Tdc

🚀 MySQL MCP 服務器

這是一個用於與 MySQL 數據庫交互的模型上下文協議（MCP）服務器，允許 MCP 客戶端（如 AI 助手）查詢和修改配置的 MySQL 數據庫中的數據，為數據操作提供了便捷的途徑。

版本

0.1.0

🚀 快速開始

此服務器可讓 MCP 客戶端輕鬆與 MySQL 數據庫進行交互，實現數據的查詢和修改。在使用前，你需要完成安裝和配置工作。

✨ 主要特性

• 使用標準連接參數連接到 MySQL 數據庫。
• 提供 MCP 工具以執行 SQL 查詢和語句。
• 支持只讀查詢 (SELECT, SHOW, DESCRIBE)。
• 通過環境變量（MYSQL_ALLOW_WRITE_OPS）支持寫操作 (INSERT, UPDATE, DELETE)，該變量設為 true 可啟用這些操作，默認禁用（寫操作不可用）。

  ⚠️ 重要提示

  啟用寫操作允許 MCP 客戶端修改您的數據庫，請謹慎使用。

• 通過標準輸入/輸出（stdio）進行通信。

📦 安裝指南

# 作為項目依賴安裝（推薦在其他項目中使用）
npm install

# 或，如果需要作為獨立全局工具：
# 1. 構建項目：
#    npm run build
# 2. 全局鏈接：
#    npm link 
#    （或使用 `npm install -g .` 如果已發佈）

📚 詳細文檔

配置

此服務器需要以下環境變量設置以進行數據庫連接：

• MYSQL_HOST：MySQL 服務器的主機名或 IP 地址。
• MYSQL_USER：用於連接到數據庫的用戶名。
• MYSQL_PASSWORD：指定用戶的密碼。
• MYSQL_DATABASE：要連接到的數據庫名稱。
• MYSQL_PORT：（可選）MySQL 服務器的端口號（默認為 3306）。
• MYSQL_ALLOW_WRITE_OPS：（可選）設為 true 可啟用 insert, update, 和 delete 工具，默認為 false（寫操作禁用）。

  ⚠️ 重要提示

  啟用寫操作允許 MCP 客戶端修改您的數據庫，請謹慎使用。

這些變量需要在服務器進程運行的環境中可用。如何設置它們取決於您的操作系統和運行服務器的方式（例如，.env 文件、系統環境變量、shell 導出）。

使用

配置完成後並構建（npm run build），您可以運行服務器：

# 如果已全局鏈接
mysql-server

# 或直接使用 node 運行
node build/index.js 

服務器將啟動並在 stderr 中打印 MySQL MCP 服務器在 stdio 上運行，然後監聽標準輸入/輸出上的 MCP 請求。您通常會配置您的 MCP 客戶端（例如 AI 助手集成）連接到此服務器進程。

可用工具

服務器為 MCP 客戶端公開以下工具：

1. query

• 描述：執行只讀 SQL 查詢（SELECT, SHOW, DESCRIBE）針對配置的數據庫。
• 輸入模式：

{
  "type": "object",
  "properties": {
    "sql": {
      "type": "string",
      "description": "要執行的只讀 SQL 查詢 (SELECT, SHOW, DESCRIBE)。"
    }
  },
  "required": ["sql"]
}

• 輸出：以 JSON 字符串形式在 MCP 響應 content 中返回查詢結果。如果查詢不是隻讀或出現數據庫錯誤，將返回錯誤。

2. insert

• 描述：執行 INSERT SQL 語句。

  ⚠️ 重要提示

  需要 MYSQL_ALLOW_WRITE_OPS 設為 true。

• 輸入模式：

{
  "type": "object",
  "properties": {
    "sql": {
      "type": "string",
      "description": "要執行的 INSERT SQL 語句。"
    }
  },
  "required": ["sql"]
}

• 輸出：成功時返回包含插入記錄數的消息，失敗時返回錯誤消息。

3. update

• 描述：執行 UPDATE SQL 語句。

  ⚠️ 重要提示

  需要 MYSQL_ALLOW_WRITE_OPS 設為 true。

• 輸入模式：

{
  "type": "object",
  "properties": {
    "sql": {
      "type": "string",
      "description": "要執行的 UPDATE SQL 語句。"
    }
  },
  "required": ["sql"]
}

• 輸出：成功時返回包含更新記錄數的消息，失敗時返回錯誤消息。