本頁說明如何將 Dataplex Universal Catalog 執行個體連結至 Gemini CLI 等開發人員工具。將 Dataplex Universal Catalog 連線至這些工具,即可直接在 IDE 中透過 AI 探索資料及管理資產。
如要使用整合式指令列,建議使用 Gemini CLI 專用的 Dataplex Universal Catalog 擴充功能。擴充功能會將基礎 Model Context Protocol (MCP) 伺服器打包,做為 Gemini CLI 與 Dataplex Universal Catalog 之間的媒介,因此不需要另外設定伺服器。
或者,您可以使用通用的 MCP Toolbox for Databases,連線至支援 MCP 的其他 IDE 和開發人員工具。然後,您可以在現有的 IDE 中使用 AI 代理程式,探索 Dataplex Universal Catalog 中的資料資產。 如要進一步瞭解 MCP,請參閱模型情境通訊協定簡介。
本指南將示範如何連結下列工具:
- Gemini CLI (透過擴充功能)
- Gemini Code Assist
- Claude 程式碼
- Claude 電腦版
- Cline (VS Code 擴充功能)
- Cursor
- Visual Studio Code (Copilot)
- Windsurf (舊稱 Codeium)
關於 Gemini CLI 和擴充功能
Gemini CLI 是 Google 的開放原始碼對話式 AI 代理程式,可加速開發工作流程,並協助編碼、偵錯、資料探索和內容建立。這項服務提供以代理程式為主的體驗,可與 Dataplex Universal Catalog 等 Data Cloud 服務,以及其他熱門的開放原始碼資料庫互動。
如要進一步瞭解 Gemini CLI,請參閱 Gemini CLI 說明文件。
擴充功能的運作方式
擴充功能可擴充 Gemini CLI 的功能,讓 Gemini CLI 連線及控制特定 Google Cloud 服務和其他工具。這些外掛程式可為 Gemini 提供背景資訊和 API 瞭解內容,進而實現對話互動。您可以從 GitHub 網址、本機目錄或登錄檔載入 Gemini CLI 擴充功能。這些擴充功能提供新的工具、斜線指令和提示。這些擴充功能與 IDE 擴充功能 (例如 Gemini Code Assist) 不同,後者是透過 MCP Toolbox 整合。
關於 Dataplex Universal Catalog 擴充功能
資料庫適用的 MCP 工具箱目前為 Beta 版 (v1.0 前),在第一個穩定版 (v1.0) 發布前,可能會出現重大變更。
Gemini CLI 的 Dataplex Universal Catalog 擴充功能可將 AI 整合至資料治理和探索工作。您可以在終端機中使用自然語言提示與 Dataplex Universal Catalog 互動。以下舉幾個例子說明:
類別 | 工具 | 自然語言提示範例 |
---|---|---|
資料探索與治理 | dataplex_search_entries |
|
dataplex_lookup_entry |
|
|
dataplex_search_aspect_types |
|
如要進一步瞭解 Dataplex Universal Catalog 擴充功能,請參閱「Gemini CLI Extension - Dataplex Universal Catalog」。
必要角色和權限
如要取得必要權限,透過 MCP Toolbox 或 Gemini CLI 擴充功能連線至 Dataplex Universal Catalog,請要求管理員授予您專案的下列 IAM 角色:
-
如要啟用 API,請按照下列步驟操作:
Service Usage Admin (
roles/serviceusage.serviceUsageAdmin
) -
如要使用 Dataplex Universal Catalog 工具:
Dataplex Catalog 檢視者 (
roles/dataplex.catalogViewer
)
如要進一步瞭解如何授予角色,請參閱「管理專案、資料夾和機構的存取權」。
這些預先定義的角色具備使用 MCP Toolbox 或 Gemini CLI 擴充功能連線至 Dataplex Universal Catalog 所需的權限。如要查看確切的必要權限,請展開「必要權限」部分:
所需權限
如要使用 MCP Toolbox 或 Gemini CLI 擴充功能連線至 Dataplex Universal Catalog,必須具備下列權限:
-
如要啟用 API,請按照下列步驟操作:
serviceusage.services.enable
-
如要使用 Dataplex Universal Catalog 工具:
-
dataplex.projects.search
-
dataplex.entries.get
-
dataplex.aspectTypes.get
-
dataplex.aspectTypes.list
-
啟用 Dataplex Universal Catalog API
- 請先查看完成本指南中工作所需的權限。
-
In the Google Cloud console, go to the project selector page.
-
Select or create a Google Cloud project.
Roles required to select or create a project
- Select a project: Selecting a project doesn't require a specific IAM role—you can select any project that you've been granted a role on.
-
Create a project: To create a project, you need the Project Creator
(
roles/resourcemanager.projectCreator
), which contains theresourcemanager.projects.create
permission. Learn how to grant roles.
-
Verify that billing is enabled for your Google Cloud project.
-
Enable the Dataplex API.
Roles required to enable APIs
To enable APIs, you need the Service Usage Admin IAM role (
roles/serviceusage.serviceUsageAdmin
), which contains theserviceusage.services.enable
permission. Learn how to grant roles. -
If you're using a local shell, then create local authentication credentials for your user account:
gcloud auth application-default login
You don't need to do this if you're using Cloud Shell.
If an authentication error is returned, and you are using an external identity provider (IdP), confirm that you have signed in to the gcloud CLI with your federated identity.
安裝 MCP Toolbox
如果您只打算使用 Gemini Code Assist 或 Gemini CLI 擴充功能,就不需要安裝 MCP Toolbox,因為這些工具已內建必要的伺服器功能。如要使用其他 IDE 和工具,請按照本節的步驟安裝 MCP Toolbox。
以二進位檔形式下載最新版 MCP Toolbox。選取與作業系統和 CPU 架構對應的二進位檔。您必須使用 MCP Toolbox v0.15.0 以上版本。
Linux/amd64
curl -O https://storage.googleapis.com/genai-toolbox/VERSION/linux/amd64/toolbox
將
VERSION
替換為 MCP Toolbox 版本,例如v0.15.0
。macOS (Darwin)/arm64
curl -O https://storage.googleapis.com/genai-toolbox/VERSION/darwin/arm64/toolbox
將
VERSION
替換為 MCP Toolbox 版本,例如v0.15.0
。macOS (Darwin)/amd64
curl -O https://storage.googleapis.com/genai-toolbox/VERSION/darwin/amd64/toolbox
將
VERSION
替換為 MCP Toolbox 版本,例如v0.15.0
。Windows/amd64
curl -O https://storage.googleapis.com/genai-toolbox/VERSION/windows/amd64/toolbox
將
VERSION
替換為 MCP Toolbox 版本,例如v0.15.0
。將二進位檔設為可執行檔:
chmod +x toolbox
驗證安裝:
./toolbox --version
安裝成功後,系統會傳回版本號碼,例如 0.15.0。
設定用戶端和連線
本節說明如何將 Dataplex Universal Catalog 連線至工具。
如果您使用 Gemini Code Assist 或獨立的 Gemini CLI,就不需要安裝或設定 MCP Toolbox,因為這些工具會一併提供必要的伺服器功能。如需設定說明,請參閱「Gemini Code Assist」或「Gemini CLI 擴充功能」分頁標籤。
如要使用其他與 MCP 相容的工具和 IDE,請先安裝 MCP Toolbox。這個工具箱是開放原始碼的模型上下文協定 (MCP) 伺服器,位於 IDE 和 Dataplex Universal Catalog 之間,可為 AI 工具提供安全有效率的控制平面。安裝完成後,請選取特定工具的分頁標籤,查看設定操作說明。
Gemini CLI 擴充功能
這個方法會使用獨立 Gemini CLI 工具的專屬 dataplex
擴充功能,不會使用 MCP Toolbox。
- 安裝 Gemini CLI。
- 從 GitHub 存放區安裝 Gemini CLI 適用的 Dataplex Universal Catalog 擴充功能:
gemini extensions install https://github.com/gemini-cli-extensions/dataplex
- 設定環境變數,連線至 Dataplex Universal Catalog 專案:
export DATAPLEX_PROJECT="PROJECT_ID"
將
PROJECT_ID
替換為您的 Google Cloud 專案 ID。 - 以互動模式啟動 Gemini CLI:
CLI 會自動載入 Dataplex Universal Catalog 擴充功能及其工具,您可以使用這些工具與資料資產互動。gemini
Gemini Code Assist
Gemini Code Assist 會一併提供必要的 MCP 伺服器功能,因此您不必另外安裝 MCP Toolbox。
- 在 VS Code 中安裝 Gemini Code Assist 擴充功能。
- 在 Gemini Code Assist 對話中啟用代理程式模式。
- 在工作目錄中,建立名為
.gemini
的資料夾。 在該檔案中建立settings.json
檔案。 - 新增下列設定,將環境變數替換為您的值,然後儲存:
{ "mcpServers": { "dataplex": { "command": "./PATH/TO/toolbox", "args": ["--prebuilt","dataplex","--stdio"], "env": { "DATAPLEX_PROJECT": "PROJECT_ID" } } } }
Claude 代碼
- 安裝 Claude Code。
- 在專案根目錄中建立
.mcp.json
檔案 (如果不存在)。 - 新增設定、將環境變數替換為您的值,然後儲存:
{ "mcpServers": { "dataplex": { "command": "./PATH/TO/toolbox", "args": ["--prebuilt","dataplex","--stdio"], "env": { "DATAPLEX_PROJECT": "PROJECT_ID" } } } }
Claude 電腦版
- 開啟 Claude Desktop,然後前往「設定」。
- 如要開啟設定檔,請在「開發人員」分頁中,按一下「編輯設定」。
- 新增設定、將環境變數替換為您的值,然後儲存:
{ "mcpServers": { "dataplex": { "command": "./PATH/TO/toolbox", "args": ["--prebuilt","dataplex","--stdio"], "env": { "DATAPLEX_PROJECT": "PROJECT_ID" } } } }
- 重新啟動 Claude 桌面版。
新的對話畫面會顯示 MCP 圖示和新的 MCP 伺服器。
Cline
- 在 VS Code 中開啟 Cline 擴充功能,然後按一下「MCP Servers」圖示。
- 輕觸「設定 MCP 伺服器」,開啟設定檔。
- 新增下列設定,將環境變數替換為您的值,然後儲存:
伺服器連線成功後,會顯示綠色的「有效」狀態。{ "mcpServers": { "dataplex": { "command": "./PATH/TO/toolbox", "args": ["--prebuilt","dataplex","--stdio"], "env": { "DATAPLEX_PROJECT": "PROJECT_ID" } } } }
Cursor
- 在專案根目錄中建立
.cursor
目錄 (如果不存在)。 - 如果
.cursor/mcp.json
檔案不存在,請建立並開啟該檔案。 - 新增下列設定,將環境變數替換為您的值,然後儲存:
{ "mcpServers": { "dataplex": { "command": "./PATH/TO/toolbox", "args": ["--prebuilt","dataplex","--stdio"], "env": { "DATAPLEX_PROJECT": "PROJECT_ID" } } } }
- 開啟「游標」,然後依序前往「設定」>「游標設定」>「MCP」。伺服器連線後,會顯示綠色的「有效」狀態。
VS Code (Copilot)
- 開啟 VS Code,並在專案根目錄中建立
.vscode
目錄 (如果不存在)。 - 如果
.vscode/mcp.json
檔案不存在,請建立並開啟該檔案。 - 新增下列設定,將環境變數替換為您的值,然後儲存:
{ "servers": { "dataplex": { "command": "./PATH/TO/toolbox", "args": ["--prebuilt","dataplex","--stdio"], "env": { "DATAPLEX_PROJECT": "PROJECT_ID" } } } }
滑浪風帆
- 開啟 Windsurf,然後前往 Cascade 助理。
- 如要開啟設定檔,請按一下 MCP 圖示,然後點選「設定」。
- 新增下列設定,將環境變數替換為您的值,然後儲存:
{ "mcpServers": { "dataplex": { "command": "./PATH/TO/toolbox", "args": ["--prebuilt","dataplex","--stdio"], "env": { "DATAPLEX_PROJECT": "PROJECT_ID" } } } }
使用工具
AI 工具現已連結至 Dataplex Universal Catalog。請嘗試要求 AI 助理尋找一些資料資產,例如 BigQuery 資料集、Cloud SQL 執行個體等。
LLM 可使用下列工具:
- dataplex_search_entries:搜尋資料資產
- dataplex_lookup_entry:擷取資料資產的中繼資料 (例如結構定義、用途、業務總覽和聯絡人)
- dataplex_search_aspect_types:搜尋切面類型
選用:新增系統指令
系統指令可為 LLM 提供特定指引,協助模型瞭解情境並生成更準確的回覆。根據建議的系統提示設定系統指示。
舉例來說,您可以新增指令,引導 LLM 如何使用 Dataplex Universal Catalog 工具:
- 系統要求尋找資料集或資料表時,請使用
dataplex_search_entries
工具。 - 如果系統要求提供資料表結構定義或中繼資料詳細資料 (例如資料品質規則或擁有權),請使用
dataplex_lookup_entry
工具。 - 如果系統詢問控管規則或分類,請先使用
dataplex_search_aspect_types
尋找相關的層面類型。
如要進一步瞭解如何設定指令,請參閱「使用指令取得符合您編碼風格的 AI 編輯內容」。
後續步驟
- 進一步瞭解 Dataplex Universal Catalog Catalog 搜尋。
- 瞭解如何將自訂來源擷取至 Dataplex Universal Catalog。
- 瞭解如何使用層面類型管理中繼資料。