Mysql MCP

🚀 zaj-MySQL-MCP

zaj-MySQL-MCP是一個基於MySQL實現的模型上下文協議（MCP）服務器，它能直接提供數據庫交互和商業智能功能。該服務器支持執行SQL查詢、分析業務數據，還能自動生成業務洞察報告，為用戶在數據庫操作和業務分析方面提供了便利。

✨ 主要特性

• 可執行針對MySQL數據庫的SELECT查詢。
• 能夠創建和管理數據庫表。
• 支持對數據庫結構進行分析。
• 可以生成並存儲業務洞察。
• 能訪問持續更新的業務洞察報告。

📦 安裝指南

請參考安裝指南。

💻 使用示例

基礎用法

以下是使用read_query工具執行SELECT查詢的示例：

# 調用read_query工具執行SELECT查詢
result = read_query('SELECT * FROM your_table')
print(result)

高級用法

以下是使用append_insight工具添加新的業務洞察並觸發報告更新的示例：

# 添加新的業務洞察
response = append_insight('新發現的業務洞察內容')
print(response)
# 此時memo://insights資源會自動更新

📚 詳細文檔

工具

查詢工具

• read_query：執行SELECT查詢以從數據庫讀取數據。

  • 輸入：query (字符串) - 需要執行的SELECT SQL語句。
  • 返回：查詢結果作為對象數組。

• write_query：執行INSERT、UPDATE或DELETE查詢。

  • 輸入：query (字符串) - 需要執行的修改數據庫的SQL語句。
  • 返回：{ affected_rows: 數字 }

• create_table：創建新的數據庫表。

  • 輸入：query (字符串) - CREATE TABLE SQL語句。
  • 返回：確認表已創建。

架構工具

• list_tables：獲取數據庫中所有表的列表。

  • 無需輸入。
  • 返回：表名數組。

• describe_table：查看特定表的架構信息。

  • 輸入：table_name (字符串) - 要描述的表名。
  • 返回：列定義數組，包含列名和類型。

分析工具

• append_insight：將新的業務洞察添加到報告資源中。
  • 輸入：insight (字符串) - 數據分析中發現的業務洞察。
  • 返回：確認已添加洞察。
  • 觸發memo://insights資源的更新。

資源

該服務器暴露一個資源：

• memo://insights：一份持續更新的業務洞察報告，彙集了分析過程中發現的所有見解。自動更新為新增的洞察被發現時通過append-insight工具添加的內容。

🔧 技術細節

此MCP服務器直接實現模型上下文協議，不依賴任何外部SDK。使用以下庫：

• mysql2：用於MySQL數據庫連接。
• yargs：用於命令行參數解析。
• readline：用於處理標準輸入輸出通信。

服務器遵循JSON-RPC 2.0協議與Claude通信，處理工具列表、資源列表以及工具執行的請求。

配置

MySQL MCP服務器使用環境變量進行配置。在根目錄下創建一個.env文件，包含以下變量：

# 數據庫連接
DB_CONNECTION=mysql

# 數據庫主機
DB_HOST=localhost

# 數據庫端口
DB_PORT=3306

# 數據庫用戶名（必需）
DB_USER=your_mysql_username

# 數據庫密碼（必需）
DB_PASSWORD=your_mysql_password

# 數據庫名（必需）
DB_NAME=your_database_name

提供了一個.env.example文件作為模板。複製並修改：

cp .env.example .env
# 然後編輯.env文件

📄 許可證

此MCP服務器根據MIT許可證發佈。