Mysql MCP Server

🚀 @davewind/mysql-mcp-server

這是一個提供只讀訪問 MySQL 數據庫的模型上下文協議（Model Context Protocol）服務器。藉助該服務器，大型語言模型（LLMs）能夠查看數據庫架構並執行只讀查詢，為數據交互提供了便捷且安全的途徑。

✨ 主要特性

1. 只讀數據庫訪問：藉助 SQL 驗證和 READ ONLY 事務，嚴格強制執行只讀操作，保障數據安全。
2. 模式發現：可自動識別並暴露數據庫表結構，方便用戶瞭解數據庫的組織形式。
3. SQL 查詢執行：提供專門的查詢工具，能夠接受並執行 SELECT 語句，滿足數據查詢需求。
4. 模型上下文協議合規性：實現 MCP 規範，可與兼容的 LLM 實現無縫集成，提升系統間的協作效率。
5. 簡單配置：易於設置，所需配置極少，降低了使用門檻。

🛠️ 工具

• query
  • 執行只讀 SQL 查詢以訪問連接的數據庫。
  • 輸入: sql (字符串): 要執行的 SQL 查詢。
  • 所有查詢均在 READ ONLY 事務中執行，確保數據的安全性。

📚 資源

該服務器提供每個表的架構信息：

• 表格架構 (mysql://user:password@localhost:port/database)
  • 提供每個表的 JSON 架構信息。
  • 包含列名和數據類型。
  • 自動從數據庫元數據中發現，方便用戶獲取數據庫的詳細結構。

📦 安裝

npm install @davewind/mysql-mcp-server -g

⚙️ 配置

MCP 設置配置文件：

💡 使用建議：推薦使用此配置文件。

{
  "mcpServers": {
    "mysql": {
      "command": "npx",
      "args": ["-y", "@davewind/mysql-mcp-server", "mysql://user:password@localhost:port/database"],
    }
  }
}

🧪 測試

⚠️ 重要提示：請替換 mysql://user:password@localhost:port/ 並運行 npm run inspector。

  "scripts": {
    "inspector": "npx @modelcontextprotocol/inspector@0.10.2 build/index.js mysql://user:password@localhost:port/database"
  }

🖥️ 環境要求

Node.js v18 +

🔧 技術細節

系統架構

MySQL MCP 服務器作為中介，介於 LLM 和 MySQL 數據庫之間，根據 MCP 協議處理請求，實現了系統間的高效交互。

組件交互

暫未提供相關組件交互的詳細內容。

安全模型

MySQL MCP 服務器實現了一個嚴格的安全模型，以確保數據庫訪問為只讀。具體安全措施包括：

1. SQL 查詢驗證，僅允許 SELECT 語句，防止非法的數據修改操作。
2. 所有查詢均在 READ ONLY 事務中執行，進一步保障數據的安全性。
3. 不支持數據修改操作（INSERT, UPDATE, DELETE 等），避免數據被意外修改。
4. 不支持數據庫架構修改（CREATE, ALTER, DROP 等），確保數據庫結構的穩定性。

🔌 集成與 LLMs

MySQL MCP 服務器設計用於與任何支持模型上下文協議的 LLM 系統一起使用。它通過 JSON - RPC over stdio 按照 MCP 規範進行通信，實現了與 LLM 系統的無縫集成。

📄 許可證

本項目採用 MIT 許可證。