Mysql Database Server 6m3

🚀 @f4ww4z/mcp-mysql-server

這是一個提供 MySQL 數據庫操作的模型上下文協議（Model Context Protocol）服務器。它允許 AI 模型通過標準化接口與 MySQL 數據庫進行交互，為數據操作提供了便捷的途徑。

🚀 快速開始

本服務器能讓 AI 模型藉助標準化接口與 MySQL 數據庫交互。下面為你介紹它的安裝、配置及使用方法。

📦 安裝指南

通過 Smithery 安裝

若要自動通過 Smithery 為 Claude Desktop 安裝 MySQL 服務器，可使用以下命令：

npx -y @smithery/cli install @f4ww4z/mcp-mysql-server --client claude

手動安裝

使用以下命令手動安裝：

npx @f4ww4z/mcp-mysql-server

🛠️ 配置說明

該服務器需要在您的 MCP 配置文件的環境變量中設置以下內容：

{
  "mcpServers": {
    "mysql": {
      "command": "npx",
      "args": ["-y", "@f4ww4z/mcp-mysql-server"],
      "env": {
        "MYSQL_HOST": "your_host",
        "MYSQL_USER": "your_user",
        "MYSQL_PASSWORD": "your_password",
        "MYSQL_DATABASE": "your_database"
      }
    }
  }
}

💻 使用示例

基礎用法

1. connect_db

使用提供的憑據建立 MySQL 數據庫連接。

use_mcp_tool({
  server_name: "mysql",
  tool_name: "connect_db",
  arguments: {
    host: "localhost",
    user: "your_user",
    password: "your_password",
    database: "your_database"
  }
});

2. query

執行帶有可選預編譯語句參數的 SELECT 查詢。

use_mcp_tool({
  server_name: "mysql",
  tool_name: "query",
  arguments: {
    sql: "SELECT * FROM users WHERE id = ?",
    params: [1]
  }
});

3. execute

執行帶有可選預編譯語句參數的 INSERT、UPDATE 或 DELETE 查詢。

use_mcp_tool({
  server_name: "mysql",
  tool_name: "execute",
  arguments: {
    sql: "INSERT INTO users (name, email) VALUES (?, ?)",
    params: ["John Doe", "john@example.com"]
  }
});

4. list_tables

列出數據庫中的所有表。

use_mcp_tool({
  server_name: "mysql",
  tool_name: "list_tables",
  arguments: {}
});

5. describe_table

獲取特定表的結構。

use_mcp_tool({
  server_name: "mysql",
  tool_name: "describe_table",
  arguments: {
    table: "users"
  }
});

✨ 主要特性

• 安全連接處理，帶自動清理功能
• 預編譯語句支持以防止 SQL 注入
• 全面的錯誤處理和驗證
• TypeScript 支持
• 自動化連接管理

🔒 安全性

• 使用預編譯語句防止 SQL 注入
• 通過環境變量支持安全密碼處理
• 查詢執行前進行驗證
• 連接使用後自動關閉

⚠️ 錯誤處理

該服務器為常見問題提供詳細的錯誤消息：

• 連接失敗
• 無效查詢
• 缺少參數
• 數據庫錯誤

🤝 貢獻

歡迎貢獻！請隨意提交 Pull Request 到 https://github.com/f4ww4z/mcp-mysql-server

📄 許可證

本項目採用 MIT 許可證。