搭配使用知識目錄與 MCP、Gemini 和其他代理程式

本頁說明如何將 Knowledge Catalog (舊稱 Dataplex Universal Catalog) 執行個體連結至 Gemini CLI 等開發人員工具。將 Knowledge Catalog 連結至這些工具,即可直接在工具中透過 AI 探索資料及管理資產。

如要取得整合式指令列體驗,建議使用 Gemini CLI 專用的 Knowledge Catalog 擴充功能。擴充功能會將基礎 Model Context Protocol (MCP) 伺服器打包,做為 Gemini CLI 和 Knowledge Catalog 之間的媒介,因此不需要另外設定伺服器。

或者,您也可以使用本機 MCP Toolbox for Databases,連線至支援 MCP 的其他 IDE 和開發人員工具。接著,您可以在現有的 IDE 中使用 AI 代理程式,探索 Knowledge Catalog 中的資料資產。如要進一步瞭解 MCP,請參閱「Model Context Protocol 簡介」。

本指南將示範如何連結下列工具:

關於 Gemini CLI 和擴充功能

Gemini CLI 是 Google 的開放原始碼對話式 AI 代理,可加速開發工作流程,並協助進行程式設計、偵錯、資料探索和內容創作。提供以代理程式為主的體驗,可與 Knowledge Catalog 等 Data Cloud 服務,以及其他熱門的開放原始碼資料庫互動。

如要進一步瞭解 Gemini CLI,請參閱 Gemini CLI 說明文件

擴充功能的運作方式

擴充功能可拓展 Gemini CLI 的能力,讓它連結及控制特定 Google Cloud 服務和其他工具。這些檔案可為 Gemini 提供脈絡和 API 瞭解資訊,進而實現對話互動。您可以從 GitHub 網址、本機目錄或登錄檔載入 Gemini CLI 擴充功能。這些擴充功能提供新的工具、斜線指令和提示。這些擴充功能與 IDE 擴充功能 (例如 Gemini Code Assist) 不同,後者是透過 MCP Toolbox 整合。

關於 Knowledge Catalog 擴充功能

Gemini CLI 的 Knowledge Catalog 擴充功能可將 AI 整合至資料治理和探索工作。您可以在終端機中使用自然語言提示與 Knowledge Catalog 互動。以下舉幾個例子說明:

類別 工具 自然語言提示範例
資料探索與治理 search_entries
  • 找出與歐洲銷售相關的所有資料集。
  • 顯示含有客戶 PII 的資料表。
  • 列出 Knowledge Catalog 中 marketing lake 的所有 BigQuery 資料集。
lookup_entry
  • orders 資料表的結構定義是什麼?
  • 說明套用至 customer 資料庫的資料品質規則。
  • customer_details 資料表中列出的業主是誰?
search_aspect_types
  • 顯示與資料品質規則相關的切面類型。
  • 列出用於資料治理的所有切面類型。
  • 是否有任何切面類型可用於標記 PII 資料?
根據脈絡建立 LLM 基礎 lookup_context (preview)
  • 說明 orders 資料資產。
  • 編寫 SQL 查詢,依國家/地區計算使用者人數。
  • 撰寫資料管道,清理 products 資料表。

如要進一步瞭解 Knowledge Catalog 擴充功能,請參閱「Gemini CLI 擴充功能 - Knowledge Catalog」。

必要的角色

如要取得使用 MCP Toolbox 或 Gemini CLI 擴充功能連線至 Knowledge Catalog 所需的權限,請要求系統管理員在專案中授予您下列 IAM 角色:

如要進一步瞭解如何授予角色,請參閱「管理專案、資料夾和組織的存取權」。

這些預先定義的角色具備使用 MCP Toolbox 或 Gemini CLI 擴充功能連線至 Knowledge Catalog 的權限。如要查看確切的必要權限,請展開「Required permissions」(必要權限) 部分:

所需權限

如要使用 MCP Toolbox 或 Gemini CLI 擴充功能連線至 Knowledge Catalog,您必須具備下列權限:

  • 如要啟用 API,請按照下列步驟操作: serviceusage.services.enable
  • 如要使用 Knowledge Catalog 工具:
    • dataplex.projects.search
    • dataplex.entries.get
    • dataplex.aspectTypes.get
    • dataplex.aspectTypes.list

您或許還可透過自訂角色或其他預先定義的角色取得這些權限。

啟用 Dataplex API

  1. 前往 Google Cloud 控制台的專案選擇器頁面。

    前往專案選取器

  2. 選取或建立 Google Cloud 專案。

    選取或建立專案所需的角色

    • 選取專案:選取專案時,不需要具備特定 IAM 角色,只要您已獲授角色,即可選取任何專案。
    • 建立專案:如要建立專案,您需要「專案建立者」角色 (roles/resourcemanager.projectCreator),其中包含 resourcemanager.projects.create 權限。瞭解如何授予角色
  3. 確認專案已啟用計費功能 Google Cloud

  4. 啟用 Dataplex API。

    啟用 API 時所需的角色

    如要啟用 API,您需要服務使用情形管理員 IAM 角色 (roles/serviceusage.serviceUsageAdmin),其中包含 serviceusage.services.enable 權限。瞭解如何授予角色

    啟用 API

  5. 如果您使用本機殼層,請為使用者帳戶建立本機驗證憑證:

    gcloud auth application-default login

    如果您使用 Cloud Shell,則不需要執行這項操作。

    如果系統傳回驗證錯誤,且您使用外部識別資訊提供者 (IdP),請確認您已 使用聯合身分登入 gcloud CLI

安裝 MCP Toolbox

如果您只打算使用 Gemini Code AssistGemini CLI 擴充功能,就不需要安裝 MCP Toolbox,因為這些工具已內建必要的伺服器功能。如要使用其他 IDE 和工具,請按照本節步驟安裝 MCP Toolbox。

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

    Linux/amd64

    curl -O https://storage.googleapis.com/mcp-toolbox-for-databases/VERSION/linux/amd64/toolbox
    

    VERSION 替換成 MCP Toolbox 版本,例如 v0.31.0

    macOS (Darwin)/arm64

    curl -O https://storage.googleapis.com/mcp-toolbox-for-databases/VERSION/darwin/arm64/toolbox
    

    VERSION 替換成 MCP Toolbox 版本,例如 v0.31.0

    macOS (Darwin)/amd64

    curl -O https://storage.googleapis.com/mcp-toolbox-for-databases/VERSION/darwin/amd64/toolbox
    

    VERSION 替換成 MCP Toolbox 版本,例如 v0.31.0

    Windows/amd64

    curl -O https://storage.googleapis.com/mcp-toolbox-for-databases/VERSION/windows/amd64/toolbox
    

    VERSION 替換成 MCP Toolbox 版本,例如 v0.31.0

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

    chmod +x toolbox
    
  3. 驗證安裝項目:

    ./toolbox --version
    

    安裝成功後,系統會傳回版本號碼,例如 0.15.0。

設定用戶端和連線

本節說明如何將 Knowledge Catalog 連結至工具。

如果您使用 Gemini Code Assist 或獨立的 Gemini CLI,則不需要安裝或設定 MCP Toolbox,因為這些工具已內建必要的伺服器功能。如需設定說明,請參閱「Gemini Code Assist」或「Gemini CLI 擴充功能」分頁。

如要使用其他與 MCP 相容的工具和 IDE,請先安裝 MCP Toolbox。這個工具箱是開放原始碼的 Model Context Protocol (MCP) 伺服器,位於 IDE 和 Knowledge Catalog 之間,可為 AI 工具提供安全有效率的控制層。安裝完成後,請選取特定工具的分頁標籤,查看設定操作說明。

Gemini CLI 擴充功能

這個方法會使用獨立 Gemini CLI 工具的專用 knowledge-catalog 擴充功能,不會使用 MCP Toolbox。

  1. 安裝 Gemini CLI
  2. 從 GitHub 存放區安裝 Gemini CLI 的 Knowledge Catalog 擴充功能:
    gemini extensions install https://github.com/gemini-cli-extensions/knowledge-catalog
  3. 設定環境變數,連線至 Knowledge Catalog 專案:
    export DATAPLEX_PROJECT="PROJECT_ID"

    PROJECT_ID 替換為 Google Cloud 專案 ID。

  4. 在互動模式下啟動 Gemini CLI:
    gemini
    CLI 會自動載入 Knowledge Catalog 擴充功能及其工具,您可以使用這些工具與資料資產互動。

Gemini Code Assist

Gemini Code Assist 會一併提供必要的 MCP 伺服器功能,因此您不必另外安裝 MCP Toolbox。

  1. 在 VS Code 中安裝 Gemini Code Assist 擴充功能。
  2. 在 Gemini Code Assist 對話中啟用 Agent 模式。
  3. 在工作目錄中,建立名為 .gemini 的資料夾。 在該檔案中建立 settings.json 檔案。
  4. 新增下列設定,將環境變數替換為您的值,然後儲存:
      {
        "mcpServers": {
          "knowledgeCatalog": {
            "command": "./PATH/TO/toolbox",
            "args": ["--prebuilt","dataplex","--stdio"],
            "env": {
              "DATAPLEX_PROJECT": "PROJECT_ID"
            }
          }
        }
      }
      

Claude 程式碼

  1. 安裝 Claude Code
  2. 在專案根目錄中建立 .mcp.json 檔案 (如果不存在)。
  3. 新增設定、將環境變數替換為您的值,然後儲存:
      {
        "mcpServers": {
          "knowledgeCatalog": {
            "command": "./PATH/TO/toolbox",
            "args": ["--prebuilt","dataplex","--stdio"],
            "env": {
              "DATAPLEX_PROJECT": "PROJECT_ID"
            }
          }
        }
      }
      

Claude 電腦版

  1. 開啟 Claude Desktop,然後前往「設定」
  2. 如要開啟設定檔,請在「開發人員」分頁中,按一下「編輯設定」
  3. 新增設定、將環境變數替換為您的值,然後儲存:
      {
        "mcpServers": {
          "knowledgeCatalog": {
            "command": "./PATH/TO/toolbox",
            "args": ["--prebuilt","dataplex","--stdio"],
            "env": {
              "DATAPLEX_PROJECT": "PROJECT_ID"
            }
          }
        }
      }
      
  4. 重新啟動 Claude 電腦版。
    新的即時通訊畫面會顯示 MCP 圖示和新的 MCP 伺服器。

Cline

  1. 在 VS Code 中開啟 Cline 擴充功能,然後按一下「MCP Servers」圖示。
  2. 輕觸「設定 MCP 伺服器」,開啟設定檔。
  3. 新增下列設定,將環境變數替換為您的值,然後儲存:
      {
        "mcpServers": {
          "knowledgeCatalog": {
            "command": "./PATH/TO/toolbox",
            "args": ["--prebuilt","dataplex","--stdio"],
            "env": {
              "DATAPLEX_PROJECT": "PROJECT_ID"
            }
          }
        }
      }
      
    伺服器連線成功後,狀態會顯示為綠色「已啟用」。

Cursor

  1. 在專案根目錄中建立 .cursor 目錄 (如果不存在)。
  2. 如果 .cursor/mcp.json 檔案不存在,請建立並開啟該檔案。
  3. 新增下列設定,將環境變數替換為您的值,然後儲存:
      {
        "mcpServers": {
          "knowledgeCatalog": {
            "command": "./PATH/TO/toolbox",
            "args": ["--prebuilt","dataplex","--stdio"],
            "env": {
              "DATAPLEX_PROJECT": "PROJECT_ID"
            }
          }
        }
      }
      
  4. 開啟「Cursor」,然後依序前往「Settings」>「Cursor Settings」>「MCP」。伺服器連線後,會顯示綠色的「有效」狀態。

VS Code (Copilot)

  1. 開啟 VS Code,並在專案根目錄中建立 .vscode 目錄 (如果不存在)。
  2. 如果 .vscode/mcp.json 檔案不存在,請建立並開啟該檔案。
  3. 新增下列設定,將環境變數替換為您的值,然後儲存:
      {
        "servers": {
          "knowledgeCatalog": {
            "command": "./PATH/TO/toolbox",
            "args": ["--prebuilt","dataplex","--stdio"],
            "env": {
              "DATAPLEX_PROJECT": "PROJECT_ID"
            }
          }
        }
      }
      

滑浪風帆

  1. 開啟 Windsurf,然後前往 Cascade 助理。
  2. 如要開啟設定檔,請點選 MCP 圖示,然後按一下「設定」
  3. 新增下列設定,將環境變數替換為您的值,然後儲存:
      {
        "mcpServers": {
          "knowledgeCatalog": {
            "command": "./PATH/TO/toolbox",
            "args": ["--prebuilt","dataplex","--stdio"],
            "env": {
              "DATAPLEX_PROJECT": "PROJECT_ID"
            }
          }
        }
      }
      

使用工具

AI 工具現已連結至 Knowledge Catalog。請嘗試要求 AI 助理尋找一些資料資產,例如 BigQuery 資料集、Cloud SQL 執行個體等。

LLM 可使用下列工具:

選用:新增系統指令

系統指令可為 LLM 提供特定指引,協助模型瞭解脈絡並生成更準確的回覆。根據建議的系統提示設定系統指令。

舉例來說,您可以新增操作說明,引導 LLM 如何使用 Knowledge Catalog 工具:

  • 系統要求尋找資料集或資料表時,請使用 search_entries 工具。
  • 如果系統要求提供資料表結構定義或中繼資料詳細資料 (例如資料品質規則或擁有權),請使用 lookup_entry 工具。
  • 如果系統詢問控管規則或分類,請先使用 search_aspect_types 尋找相關的層面類型。
  • 如果回答問題需要大量中繼資料,請使用 lookup_context 工具擷取。

如要進一步瞭解如何設定指令,請參閱「使用指令取得符合您編碼風格的 AI 編輯內容」。

後續步驟