Zaj MySQL

🚀 MySQL - MCP 服務器實現

MySQL - MCP 服務器直接實現了模型上下文協議 (MCP)，無需依賴外部 SDK。它具備數據庫交互和商業智能功能，可通過 MySQL 進行 SQL 查詢、數據分析，並自動生成業務洞察備忘錄，為用戶提供便捷的數據庫操作和商業分析體驗。

🚀 快速開始

項目還提供了示例數據庫和查詢，幫助用戶快速上手。按照以下步驟構建並運行服務器：

1. 克隆倉庫

   git clone https://github.com/username/mysql-mcp.git
   cd mysql-mcp
   

2. 安裝依賴

   npm install
   

3. 構建服務端點

   npm run build
   

4. 啟動服務器

   npm start
   

✨ 主要特性

• 執行 SQL 查詢操作 MySQL 數據庫
• 創建和管理數據庫表
• 分析數據表結構
• 生成並存儲業務洞察
• 訪問持續更新的業務洞察備忘錄

📦 安裝指南

服務器通過環境變量進行配置，需創建根目錄下的 .env 文件，幷包含以下內容：

# 數據庫配置
DB_HOST=數據庫主機地址  
DB_PORT=數據庫端口號  
DB_USER=數據庫用戶名  
DB_PASSWORD=數據庫密碼  
DB_NAME=使用的數據庫名稱

.env.example 文件提供了模板，用戶可複製並根據實際需要修改。

💻 使用示例

基礎用法

以下是服務器工具集的使用示例：

查詢工具

• read_query：執行 SELECT 查詢以讀取數據庫中的數據
  • 輸入：query（字符串）—— 需要執行的 SELECT SQL 查詢語句
  • 返回：查詢結果，格式為對象數組

// 示例代碼
const result = read_query('SELECT * FROM users');
console.log(result);

• write_query：執行 INSERT、UPDATE 或 DELETE 操作
  • 輸入：query（字符串）—— 需要執行的修改 SQL 語句
  • 返回：{ affected_rows: 數量 }

// 示例代碼
const updateResult = write_query('UPDATE users SET name = "John" WHERE id = 1');
console.log(updateResult);

• create_table：在數據庫中創建新表
  • 輸入：query（字符串）—— CREATE TABLE 的 SQL 語句
  • 返回：確認表已創建的信息

// 示例代碼
const createTableResult = create_table('CREATE TABLE new_table (id INT, name VARCHAR(255))');
console.log(createTableResult);

架構工具

• list_tables：獲取數據庫中的所有表的列表
  • 不需要輸入
  • 返回：表名數組

// 示例代碼
const tables = list_tables();
console.log(tables);

• describe_table：查看特定表的架構信息
  • 輸入：table_name（字符串）—— 要描述的表名
  • 返回：包含列定義及其名稱和類型的數組

// 示例代碼
const tableSchema = describe_table('users');
console.log(tableSchema);

分析工具

• append_insight：將新的業務洞察添加到備忘錄資源中
  • 輸入：insight（字符串）—— 數據分析中發現的業務見解
  • 返回：確認已添加見解的信息
  • 觸發對 memo://insights 資源的更新

// 示例代碼
const addInsightResult = append_insight('用戶活躍度有所提升');
console.log(addInsightResult);

高級用法

在與 Claude 集成時，可在 cline_mcp_settings.json 中添加服務器配置：

{
  "servers": [
    {
      "name": "MySQL-MCP",
      "command": "node server.js", // 啟動命令
      "parameters": {} // 可選參數
    }
  ]
}

用戶通過 .env 文件管理敏感信息，確保配置的安全性。

📚 詳細文檔

工具集

查詢工具

• 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：一個持續更新的業務洞察備忘錄，聚合了分析過程中發現的所有見解
  • 隨著新見解的添加而自動更新

🔧 技術細節

該 MCP 服務器直接使用 JSON - RPC 2.0 協議與 Claude 通信，處理工具列表、資源列表和工具執行請求。其實現依賴以下庫：

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

📄 許可證

該 MCP 服務器採用 MIT 許可證。