DB Connector (MySQL/PostgreSQL)

🚀 DB MCP Server

DB MCP Server 是一款實用的服務器工具，它能幫助你便捷地與數據庫進行交互。通過簡單的配置和操作，即可快速啟動服務，實現數據的查詢、事務執行等功能。

🚀 快速開始

要快速啟動並運行DB MCP Server，請按照以下步驟操作：

1. 下載源碼：

   git clone https://github.com/FreePeak/db-mcp-server.git
   cd db-mcp-server
   

2. 安裝依賴： 在項目根目錄下，執行：

   go mod tidy
   

3. 構建二進制文件： 執行以下命令編譯可執行文件：

   go build -o bin/server .
   

4. 運行服務： 啟動服務器：

   ./bin/server --config=config.json
   

5. 訪問文檔： 查看docs/目錄下的詳細使用說明。

📦 安裝指南

安裝依賴項

確保已安裝以下工具：

• Go語言環境（推薦版本1.20或更高）
• Git用於克隆倉庫

克隆倉庫

在終端中運行：

git clone https://github.com/FreePeak/db-mcp-server.git
cd db-mcp-server

安裝依賴

執行以下命令安裝項目所需的Go包：

go mod tidy

構建可執行文件

構建服務器二進制文件：

go build -o bin/server .

配置服務

創建config.json配置文件，參考示例內容：

{
    "port": 9095,
    "mode": "sae", // 可選值：sae、http
    "connections": [
        {
            "id": "mysql1",
            "type": "mysql",
            "host": "localhost",
            "port": 3306,
            "user": "root",
            "password": "password",
            "name": "testdb"
        }
    ]
}

啟動服務

運行以下命令啟動服務器：

./bin/server --config=config.json

💻 使用示例

基本用法

SSE模式

在瀏覽器或其他客戶端中，可以通過如下方式連接：

const eventSource = new EventSource('http://localhost:9095/sse');
eventSource.onmessage = (event) => {
    console.log('Received:', event.data);
};

HTTP模式

通過REST API進行交互，支持JSON請求和響應。

高級用法

示例使用場景

• 查詢數據：

{
    "tool": "query_mysql",
    "params": {
        "query": "SELECT * FROM users LIMIT 10"
    }
}

• 執行事務：

{
    "tool": "transaction_mysql",
    "params": {
        "operations": [
            { "query": "UPDATE orders SET status = 'paid'" },
            { "query": "INSERT INTO log (action) VALUES ('order paid')" }
        ]
    }
}

配置文件說明

config.json主要包含以下配置項：

📚 詳細文檔

常見問題與故障排除

1. 服務啟動失敗

• 原因：配置文件錯誤或數據庫連接不上。
• 解決方法：
  • 檢查config.json中的數據庫參數是否正確。
  • 確保數據庫服務已運行且網絡可達。

2. SSE模式無法建立連接

• 原因：防火牆阻止了SSE通信，或者瀏覽器不支持EventSource API。
• 解決方法：
  • 確保目標端口開放，並檢查網絡連通性。
  • 使用最新版本的現代瀏覽器訪問服務。

3. 性能問題

• 原因：連接池配置不當或查詢效率低下。
• 解決方法：
  • 根據數據庫性能調優連接池參數，如max_open_conns和max_idle_conns。
  • 優化SQL查詢語句，避免全表掃描。

4. 日誌與調試

• 日誌輸出：默認情況下，服務會輸出標準日誌到控制檯。若要啟用文件日誌，請參考文檔進行配置。
• 錯誤排查：檢查服務器端口是否被佔用，查看具體錯誤信息並解決問題。

更多資源

• 官方文檔
• 社區討論區
• 源碼倉庫

⚠️ 重要提示

如果遇到問題或有改進建議，請隨時在GitHub上提出issue。