使用 MCP Toolbox 將 IDE 連線至 AlloyDB

本頁面說明如何使用 MCP Toolbox for Databases,將 AlloyDB for PostgreSQL 執行個體連線至支援 Model Context Protocol (MCP) 的整合開發環境 (IDE) 和開發人員工具。您可以使用這些工具執行 SQL 查詢,並與資料庫互動。本指南適用於使用現有 IDE 和開發人員工具操作 AlloyDB 的開發人員。

本頁面假設您有 AlloyDB 資料庫,且 AlloyDB 執行個體具有公開 IP 位址。詳情請參閱「使用 MCP 工具箱建立 AlloyDB 資料庫」。

模型上下文協定 (MCP) 是一種開放協定,可將大型語言模型 (LLM) 連線至 AlloyDB 等資料來源。本頁說明如何使用 MCP Toolbox for Databases,透過下列 IDE 將開發人員輔助工具公開給 AlloyDB 執行個體:

事前準備

請確認您具備必要角色。

必要的角色

如要連線至 AlloyDB 執行個體,您需要下列角色或同等的身分與存取權管理 (IAM) 權限:

  • Cloud AlloyDB Client (roles/alloydb.client)
  • 服務使用情形消費者 (roles/serviceusage.serviceUsageConsumer)

設定資料庫

  1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.
  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  3. Verify that billing is enabled for your Google Cloud project.

  4. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  5. Verify that billing is enabled for your Google Cloud project.

  6. 啟用建立及連線至 PostgreSQL 適用的 AlloyDB 時所需的 Cloud API。

    啟用 API

    1. 在「確認專案」步驟中,按一下「下一步」,確認要變更的專案名稱。

    2. 在「啟用 API」步驟中,按一下「啟用」,啟用下列項目:

      • AlloyDB API
      • Compute Engine API
      • Cloud Resource Manager API
      • Service Networking API

      如果您打算使用與 AlloyDB 位於相同 Google Cloud 專案的虛擬私有雲網路,設定 AlloyDB 的網路連線,就必須啟用 Service Networking API。

      如果您打算使用位於不同 Google Cloud 專案的 VPC 網路,設定 AlloyDB 的網路連線,則必須使用 Compute Engine API 和 Cloud Resource Manager API。

  7. 建立或選取叢集及其主要執行個體。MCP Toolbox 會使用 AlloyDB 語言連接器安全連線至執行個體。
  8. 為環境設定應用程式預設憑證 (ADC)
  9. 建立或重複使用資料庫使用者。準備好輸入使用者名稱和密碼。
  10. 安裝 MCP Toolbox

    1. 以二進位檔形式下載最新版 MCP Toolbox。選取與作業系統 (OS) 和 CPU 架構對應的二進位檔。您必須使用 MCP Toolbox V0.7.0 以上版本。

      linux/amd64

      curl -O https://storage.googleapis.com/genai-toolbox/v0.7.0/linux/amd64/toolbox

      darwin/arm64

      curl -O https://storage.googleapis.com/genai-toolbox/v0.7.0/darwin/arm64/toolbox

      darwin/amd64

      curl -O https://storage.googleapis.com/genai-toolbox/v0.7.0/darwin/amd64/toolbox

      windows/amd64

      curl -O https://storage.googleapis.com/genai-toolbox/v0.7.0/windows/amd64/toolbox

    2. 將二進位檔設為可執行檔。

      chmod +x toolbox
      
    3. 驗證安裝。

      ./toolbox --version
      

    設定 MCP 用戶端

    Claude 代碼

    1. 安裝 Claude Code
    2. 如果專案根目錄中沒有 .mcp.json 檔案,請建立該檔案。
    3. 新增設定、將環境變數替換為您的值,然後儲存。

    {
      "mcpServers": {
        "alloydb": {
          "command": "./PATH/TO/toolbox",
          "args": ["--prebuilt","alloydb-postgres","--stdio"],
          "env": {
              "ALLOYDB_POSTGRES_PROJECT": "PROJECT_ID",
              "ALLOYDB_POSTGRES_REGION": "REGION",
              "ALLOYDB_POSTGRES_CLUSTER": "CLUSTER_NAME",
              "ALLOYDB_POSTGRES_INSTANCE": "INSTANCE_NAME",
              "ALLOYDB_POSTGRES_DATABASE": "DATABASE_NAME",
              "ALLOYDB_POSTGRES_USER": "USERNAME",
              "ALLOYDB_POSTGRES_PASSWORD": "PASSWORD"
          }
        }
      }
    }
    

    Claude 電腦版

    1. 開啟 Claude Desktop,然後前往「設定」
    2. 在「開發人員」分頁中,按一下「編輯設定」開啟設定檔。
    3. 新增設定、將環境變數替換為您的值,然後儲存。

    {
      "mcpServers": {
        "alloydb": {
          "command": "./PATH/TO/toolbox",
          "args": ["--prebuilt","alloydb-postgres","--stdio"],
          "env": {
              "ALLOYDB_POSTGRES_PROJECT": "PROJECT_ID",
              "ALLOYDB_POSTGRES_REGION": "REGION",
              "ALLOYDB_POSTGRES_CLUSTER": "CLUSTER_NAME",
              "ALLOYDB_POSTGRES_INSTANCE": "INSTANCE_NAME",
              "ALLOYDB_POSTGRES_DATABASE": "DATABASE_NAME",
              "ALLOYDB_POSTGRES_USER": "USERNAME",
              "ALLOYDB_POSTGRES_PASSWORD": "PASSWORD"
          }
        }
      }
    }
    
    1. 重新啟動 Claude Desktop。
    2. 新的即時通訊畫面會顯示槌子 (MCP) 圖示和新的 MCP 伺服器。

    Cline

    1. 在 VS Code 中開啟 Cline 擴充功能,然後輕觸「MCP Servers」圖示。
    2. 按一下「設定 MCP 伺服器」開啟設定檔。
    3. 新增下列設定,將環境變數換成您的值,然後儲存。

    {
      "mcpServers": {
        "alloydb": {
         "command": "./PATH/TO/toolbox",
          "args": ["--prebuilt","alloydb-postgres","--stdio"],
          "env": {
              "ALLOYDB_POSTGRES_PROJECT": "PROJECT_ID",
              "ALLOYDB_POSTGRES_REGION": "REGION",
              "ALLOYDB_POSTGRES_CLUSTER": "CLUSTER_NAME",
              "ALLOYDB_POSTGRES_INSTANCE": "INSTANCE_NAME",
              "ALLOYDB_POSTGRES_DATABASE": "DATABASE_NAME",
              "ALLOYDB_POSTGRES_USER": "USERNAME",
              "ALLOYDB_POSTGRES_PASSWORD": "PASSWORD"
          }
        }
      }
    }
    

    伺服器連線成功後,會顯示綠色的「有效」狀態。

    Cursor

    1. 如果專案根目錄中沒有 .cursor 目錄,請建立該目錄。
    2. 如果 .cursor/mcp.json 檔案不存在,請建立並開啟該檔案。
    3. 新增下列設定,將環境變數換成您的值,然後儲存。
    {
      "mcpServers": {
        "alloydb": {
          "command": "./PATH/TO/toolbox",
          "args": ["--prebuilt","alloydb-postgres","--stdio"],
          "env": {
              "ALLOYDB_POSTGRES_PROJECT": "PROJECT_ID",
              "ALLOYDB_POSTGRES_REGION": "REGION",
              "ALLOYDB_POSTGRES_CLUSTER": "CLUSTER_NAME",
              "ALLOYDB_POSTGRES_INSTANCE": "INSTANCE_NAME",
              "ALLOYDB_POSTGRES_DATABASE": "DATABASE_NAME",
              "ALLOYDB_POSTGRES_USER": "USERNAME",
              "ALLOYDB_POSTGRES_PASSWORD": "PASSWORD"
          }
        }
      } 
    }
    
    1. 開啟「游標」,然後依序前往「設定」>「游標設定」>「MCP」。伺服器連線後,會顯示綠色的「有效」狀態。

    Visual Studio Code (Copilot)

    1. 開啟 VS Code,並在專案根目錄中建立 .vscode 目錄 (如果不存在)。
    2. 如果 .vscode/mcp.json 檔案不存在,請建立並開啟該檔案。
    3. 新增下列設定,將環境變數換成您的值,然後儲存。
    {
     "mcp":{
        "servers": {
          "alloydb": {
            "command": "./PATH/TO/toolbox",
            "args": ["--prebuilt","alloydb-postgres","--stdio"],
            "env": {
              "ALLOYDB_POSTGRES_PROJECT": "PROJECT_ID",
              "ALLOYDB_POSTGRES_REGION": "REGION",
              "ALLOYDB_POSTGRES_CLUSTER": "CLUSTER_NAME",
              "ALLOYDB_POSTGRES_INSTANCE": "INSTANCE_NAME",
              "ALLOYDB_POSTGRES_DATABASE": "DATABASE_NAME",
              "ALLOYDB_POSTGRES_USER": "USERNAME",
              "ALLOYDB_POSTGRES_PASSWORD": "PASSWORD"
            }
          }
        }
      }
    }
    

    滑浪風帆

    1. 開啟 Windsurf,然後前往 Cascade 助理。
    2. 按一下 MCP 圖示,然後點選「設定」開啟設定檔。
    3. 新增下列設定,將環境變數換成您的值,然後儲存。
    {
      "mcpServers": {
        "alloydb": {
          "command": "./PATH/TO/toolbox",
          "args": ["--prebuilt","alloydb-postgres","--stdio"],
          "env": {
              "ALLOYDB_POSTGRES_PROJECT": "PROJECT_ID",
              "ALLOYDB_POSTGRES_REGION": "REGION",
              "ALLOYDB_POSTGRES_CLUSTER": "CLUSTER_NAME",
              "ALLOYDB_POSTGRES_INSTANCE": "INSTANCE_NAME",
              "ALLOYDB_POSTGRES_DATABASE": "DATABASE_NAME",
              "ALLOYDB_POSTGRES_USER": "USERNAME",
              "ALLOYDB_POSTGRES_PASSWORD": "PASSWORD"
          }
        }
      }
    }
    

    Gemini CLI

    1. 安裝 Gemini CLI
    2. 在工作目錄中,建立名為 .gemini 的資料夾。在其中建立 settings.json 檔案。
    3. 新增下列設定,將環境變數替換成您的值,然後儲存。
    {
      "mcpServers": {
        "alloydb": {
          "command": "./PATH/TO/toolbox",
          "args": ["--prebuilt","alloydb-postgres","--stdio"],
          "env": {
              "ALLOYDB_POSTGRES_PROJECT": "PROJECT_ID",
              "ALLOYDB_POSTGRES_REGION": "REGION",
              "ALLOYDB_POSTGRES_CLUSTER": "CLUSTER_NAME",
              "ALLOYDB_POSTGRES_INSTANCE": "INSTANCE_NAME",
              "ALLOYDB_POSTGRES_DATABASE": "DATABASE_NAME",
              "ALLOYDB_POSTGRES_USER": "USERNAME",
              "ALLOYDB_POSTGRES_PASSWORD": "PASSWORD"
          }
        }
      }
    }
    

    Gemini Code Assist

    1. 在 Visual Studio Code 中安裝 Gemini Code Assist 擴充功能。
    2. 在 Gemini Code Assist 對話中啟用代理程式模式。
    3. 在工作目錄中,建立名為 .gemini 的資料夾。在其中建立 settings.json 檔案。
    4. 新增下列設定,將環境變數替換成您的值,然後儲存。
    {
      "mcpServers": {
        "alloydb": {
          "command": "./PATH/TO/toolbox",
          "args": ["--prebuilt","alloydb-postgres","--stdio"],
          "env": {
              "ALLOYDB_POSTGRES_PROJECT": "PROJECT_ID",
              "ALLOYDB_POSTGRES_REGION": "REGION",
              "ALLOYDB_POSTGRES_CLUSTER": "CLUSTER_NAME",
              "ALLOYDB_POSTGRES_INSTANCE": "INSTANCE_NAME",
              "ALLOYDB_POSTGRES_DATABASE": "DATABASE_NAME",
              "ALLOYDB_POSTGRES_USER": "USERNAME",
              "ALLOYDB_POSTGRES_PASSWORD": "PASSWORD"
          }
        }
      }
    }
    

    使用 AI 工具

    您的 AI 工具現已透過 MCP 連線至 AlloyDB。您可以提示 AI 助理列出資料表、建立資料表,或定義及執行其他 SQL 陳述式。

    LLM 可使用下列工具:

    • list_tables:列出資料表和說明。
    • execute_sql:執行任何 SQL 陳述式。