将 IDE 连接到 Dataplex Universal Catalog

本文档介绍如何使用 MCP Toolbox for Databases 将 Dataplex Universal Catalog 连接到支持 Model Context Protocol (MCP) 的各种集成开发环境 (IDE) 和开发者工具。您随后可以在现有工具中使用 AI 代理来发现 Dataplex Universal Catalog 中的数据资产。

MCP 是一种开放协议,用于将大语言模型 (LLM) 连接到 Dataplex Universal Catalog 等数据源。如需详细了解 MCP,请参阅 Model Context Protocol 简介

本指南演示了适用于以下 IDE 的连接过程:

准备工作

  1. In the Google Cloud console, go to the project selector page.

    Go to project selector

  2. Select or create a Google Cloud project.

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

  4. 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

  1. 以二进制文件形式下载最新版本的 MCP Toolbox。选择与您的操作系统 (OS) 和 CPU 架构对应的二进制文件。您必须使用 MCP Toolbox v0.12.0 或更高版本。

    Linux/amd64

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

    VERSION 替换为 MCP Toolbox 版本,例如 v0.12.0

    macOS (Darwin)/arm64

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

    VERSION 替换为 MCP Toolbox 版本,例如 v0.12.0

    macOS (Darwin)/amd64

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

    VERSION 替换为 MCP Toolbox 版本,例如 v0.12.0

    Windows/amd64

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

    VERSION 替换为 MCP Toolbox 版本,例如 v0.12.0

  2. 将该二进制文件设为可执行文件:

    chmod +x toolbox
    
  3. 验证安装:

    ./toolbox --version
    

    安装成功后,系统会返回版本号,例如 0.10.0。

配置 MCP 客户端

Gemini CLI

  1. 安装 Gemini CLI
  2. 在工作目录中,创建一个名为 .gemini 的文件夹。 在该文件夹中,创建一个 settings.json 文件。
  3. 添加以下配置,将环境变量替换为您的值,然后保存:
      {
        "mcpServers": {
          "dataplex": {
            "command": "./PATH/TO/toolbox",
            "args": ["--prebuilt","dataplex","--stdio"],
            "env": {
              "DATAPLEX_PROJECT": "PROJECT_ID"
            }
          }
        }
      }
      

Gemini Code Assist

  1. 在 VS Code 中,安装 Gemini Code Assist 扩展程序。
  2. 在 Gemini Code Assist 对话中启用智能体模式。
  3. 在工作目录中,创建一个名为 .gemini 的文件夹。 在该文件夹中,创建一个 settings.json 文件。
  4. 添加以下配置,将环境变量替换为您的值,然后保存:
      {
        "mcpServers": {
          "dataplex": {
            "command": "./PATH/TO/toolbox",
            "args": ["--prebuilt","dataplex","--stdio"],
            "env": {
              "DATAPLEX_PROJECT": "PROJECT_ID"
            }
          }
        }
      }
      

Claude Code

  1. 安装 Claude Code
  2. 在项目根目录中创建 .mcp.json 文件(如果尚不存在)。
  3. 添加配置,将环境变量替换为您的值,然后保存:
      {
        "mcpServers": {
          "dataplex": {
            "command": "./PATH/TO/toolbox",
            "args": ["--prebuilt","dataplex","--stdio"],
            "env": {
              "DATAPLEX_PROJECT": "PROJECT_ID"
            }
          }
        }
      }
      

Claude Desktop

  1. 打开 Claude Desktop,然后前往设置
  2. 如需打开配置文件,请在开发者标签页中点击修改配置
  3. 添加配置,将环境变量替换为您的值,然后保存:
      {
        "mcpServers": {
          "dataplex": {
            "command": "./PATH/TO/toolbox",
            "args": ["--prebuilt","dataplex","--stdio"],
            "env": {
              "DATAPLEX_PROJECT": "PROJECT_ID"
            }
          }
        }
      }
      
  4. 重启 Claude Desktop。
    新聊天界面会显示 MCP 图标以及新的 MCP 服务器。

Cline

  1. 在 VS Code 中,打开 Cline 扩展程序,然后点击 MCP 服务器图标。
  2. 如需打开配置文件,请点按配置 MCP 服务器
  3. 添加以下配置,将环境变量替换为您的值,然后保存:
      {
        "mcpServers": {
          "dataplex": {
            "command": "./PATH/TO/toolbox",
            "args": ["--prebuilt","dataplex","--stdio"],
            "env": {
              "DATAPLEX_PROJECT": "PROJECT_ID"
            }
          }
        }
      }
      
    服务器成功连接后,系统会显示绿色的活跃状态。

光标

  1. 在项目根目录中创建 .cursor 目录(如果尚不存在)。
  2. 创建 .cursor/mcp.json 文件(如果尚不存在)并打开该文件。
  3. 添加以下配置,将环境变量替换为您的值,然后保存:
      {
        "mcpServers": {
          "dataplex": {
            "command": "./PATH/TO/toolbox",
            "args": ["--prebuilt","dataplex","--stdio"],
            "env": {
              "DATAPLEX_PROJECT": "PROJECT_ID"
            }
          }
        }
      }
      
  4. 打开 Cursor,然后依次前往设置 > Cursor 设置 > MCP。服务器连接时,系统会显示绿色的活跃状态。

VS Code (Copilot)

  1. 打开 VS Code,并在项目根目录中创建 .vscode 目录(如果尚不存在)。
  2. 创建 .vscode/mcp.json 文件(如果尚不存在)并打开该文件。
  3. 添加以下配置,将环境变量替换为您的值,然后保存:
      {
        "servers": {
          "dataplex": {
            "command": "./PATH/TO/toolbox",
            "args": ["--prebuilt","dataplex","--stdio"],
            "env": {
              "DATAPLEX_PROJECT": "PROJECT_ID"
            }
          }
        }
      }
      

Windsurf

  1. 打开 Windsurf 并前往 Cascade 助理。
  2. 如需打开配置文件,请点击 MCP 图标,然后点击配置
  3. 添加以下配置,将环境变量替换为您的值,然后保存:
      {
        "mcpServers": {
          "dataplex": {
            "command": "./PATH/TO/toolbox",
            "args": ["--prebuilt","dataplex","--stdio"],
            "env": {
              "DATAPLEX_PROJECT": "PROJECT_ID"
            }
          }
        }
      }
      

使用这些工具

您的 AI 工具现在已使用 MCP 连接到 Dataplex Universal Catalog。您可以尝试让 AI 助理查找一些数据资产,例如 BigQuery 数据集、Cloud SQL 实例等。

LLM 可使用以下工具:

可选:添加系统指令

系统指令可用于为 LLM 提供特定准则,帮助其了解上下文并更准确地回答问题。根据推荐的系统提示设置系统指令。

如需详细了解如何配置指令,请参阅使用指令获取符合您编码风格的 AI 编辑内容