将知识目录与 MCP、Gemini 和其他代理搭配使用

本页面介绍了如何将 Knowledge Catalog(以前称为 Dataplex Universal Catalog)实例连接到开发者工具,例如 Gemini CLI。将 Knowledge Catalog 连接到这些工具后,您就可以直接在工具中进行 AI 驱动的数据发现和资产管理。

如需使用本地 MCP Toolbox 服务器将数据沿袭连接到开发者工具,请参阅 将数据沿袭与本地 MCP Toolbox 服务器搭配使用

为了获得集成式命令行体验,我们建议使用专用的适用于 Knowledge Catalog 的 Gemini CLI 扩展程序。 该扩展程序直接将底层技能捆绑到扩展程序中,从而简化了设置和配置。

或者,您可以使用本地 MCP Toolbox for Databases连接支持 MCP 的其他 IDE 和开发者工具。您随后可以在现有 IDE 中使用 AI 代理来发现 Knowledge Catalog 中的数据资产。 如需详细了解 MCP,请参阅 Model Context Protocol 简介

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

Gemini CLI 和扩展程序简介

Gemini CLI 是 Google 提供的开源对话式 AI 智能体,可加速开发工作流,并协助完成编码、调试、数据探索和内容创建。它提供了一种由代理驱动的体验,可与 Data Cloud 服务(例如 Knowledge Catalog)以及其他热门开源数据库进行交互。

如需详细了解 Gemini CLI,请参阅 Gemini CLI 文档

Gemini CLI 扩展程序的工作原理

扩展程序可扩展 Gemini CLI 的功能,使其能够 连接和控制特定 Google Cloud 服务和其他工具。 它们可为 Gemini 提供上下文和 API 理解能力,从而实现对话式交互。您可以从 GitHub 网址、本地目录或注册表中加载 Gemini CLI 扩展程序。这些扩展程序提供新的技能、斜杠命令和提示。这些扩展程序与使用 MCP Toolbox 集成的 IDE 扩展程序(例如 Gemini Code Assist)是分开的。

Knowledge Catalog 提供哪些 MCP 工具?

适用于 Gemini CLI 的 Knowledge Catalog 扩展程序将 AI 集成到数据治理和发现任务中。您可以在终端中使用自然语言提示与 Knowledge Catalog 进行交互。

如需查看所有可用技能,请参阅 GitHub 上的 Knowledge Catalog 技能

如需详细了解 Knowledge Catalog 扩展程序,请参阅 Gemini CLI 扩展程序 - Knowledge Catalog

所需的角色

如需获得使用 MCP Toolbox 或 Gemini CLI 扩展程序连接到 Knowledge Catalog 所需的权限,请让您的管理员为您授予项目的以下 IAM 角色:

如需详细了解如何授予角色,请参阅管理对项目、文件夹和组织的访问权限

这些预定义角色可提供 使用 MCP Toolbox 或 Gemini CLI 扩展程序连接到 Knowledge Catalog 所需的权限。如需查看所需的确切权限,请展开所需权限部分:

所需权限

使用 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 角色,您可以选择已获授予角色的任何项目。
    • 创建项目:如需创建项目,您需要 Project Creator 角色 (roles/resourcemanager.projectCreator),该角色包含 resourcemanager.projects.create 权限。了解如何授予 角色
  3. 验证是否已为您的 Google Cloud 项目启用结算功能。

  4. 启用 Dataplex API。

    启用 API 所需的角色

    如需启用 API,您需要拥有 serviceusage.services.enable 权限。如果您已创建项目,则可能已通过 Owner 角色 (roles/owner) 拥有此权限。否则,您可以通过 Service Usage Admin 角色 (roles/serviceusage.serviceUsageAdmin) 获取此权限。 了解如何授予角色

    启用 API

  5. 如果您使用的是本地 shell,请为您的用户 账号创建本地身份验证凭证:

    gcloud auth application-default login

    如果您使用的是 Cloud Shell,则无需执行此操作。

    如果系统返回身份验证错误,并且您使用的是外部身份提供方 (IdP),请确认您已 使用联合身份登录 gcloud CLI

安装 MCP Toolbox

如果您仅打算使用 Gemini Code AssistGemini CLI 扩展程序,则无需安装 MCP Toolbox, 因为它们会捆绑所需的服务器功能。对于其他 IDE 和工具,请按照本部分中的步骤安装 MCP Toolbox。

  1. 以二进制文件形式下载最新版本的 MCP Toolbox。选择与您的操作系统 (OS) 和 CPU 架构对应的 MCP Toolbox 二进制文件版本。您必须使用 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 连接到您的工具。

如需连接与 MCP 兼容的工具和 IDE,您必须先 安装 MCP Toolbox。该工具箱充当位于 IDE 和 Knowledge Catalog 之间的开源 Model Context Protocol (MCP) 服务器,为 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 CLI 中,使用 /extensions 命令验证扩展程序是否已安装。

Gemini Code Assist

Gemini Code Assist 会捆绑所需的 MCP 服务器功能,因此您无需单独安装 MCP Toolbox。

  1. 在 VS Code 中,安装 Gemini Code Assist 扩展程序。
  2. 在 Gemini Code Assist 对话中启用智能体模式
  3. 在工作目录中,创建一个名为 .gemini 的文件夹。在该文件夹中,创建一个 settings.json 文件。
  4. 添加以下配置:

    {
      "mcpServers": {
        "knowledgeCatalog": {
          "command": "./PATH/TO/toolbox",
          "args": ["--prebuilt","dataplex","--stdio"],
          "env": {
            "DATAPLEX_PROJECT": "PROJECT_ID"
          }
        }
      }
    }
    

    PROJECT_ID 替换为 Google Cloud 项目 ID。

  5. 保存配置。

Claude Code

  1. 安装 Claude Code
  2. 设置环境变量以连接到 Knowledge Catalog 项目:

    export DATAPLEX_PROJECT=PROJECT_ID
    

    PROJECT_ID 替换为 Google Cloud 项目 ID。

  3. 启动代理:

    claude
    
  4. 安装插件:

    /plugin install knowledge-catalog@claude-plugins-official
    

Codex

  1. 安装 Data Agent Kit Marketplace:

    codex plugin marketplace add GoogleCloudPlatform/data-agent-kit
    
  2. 安装 Knowledge Catalog 插件:

    codex plugin install dataplex@data-agent-kit
    
  3. 配置环境变量以连接到 Knowledge Catalog 项目:

    export DATAPLEX_PROJECT=PROJECT_ID
    

    PROJECT_ID 替换为 Google Cloud 项目 ID。

  4. 可选。更新 Marketplace:

    codex plugin marketplace upgrade data-agent-kit
    

Claude Desktop

  1. 打开 Claude Desktop,然后前往 设置
  2. 如需打开配置文件,请前往开发者 标签页,然后点击修改配置
  3. 添加以下配置:

    {
      "mcpServers": {
        "knowledgeCatalog": {
          "command": "./PATH/TO/toolbox",
          "args": ["--prebuilt","dataplex","--stdio"],
          "env": {
            "DATAPLEX_PROJECT": "PROJECT_ID"
          }
        }
      }
    }
    

    PROJECT_ID 替换为 Google Cloud 项目 ID。

  4. 保存配置。

  5. 重启 Claude Desktop。新聊天界面会显示 MCP 图标,表示新的 MCP 服务器。

Cline

  1. 在 VS Code 中,打开 Cline 扩展程序,然后点击 MCP 服务器 图标。
  2. 如需打开配置文件,请点击配置 MCP 服务器
  3. 添加以下配置:

    {
      "mcpServers": {
        "knowledgeCatalog": {
          "command": "./PATH/TO/toolbox",
          "args": ["--prebuilt","dataplex","--stdio"],
          "env": {
            "DATAPLEX_PROJECT": "PROJECT_ID"
          }
        }
      }
    }
    

    PROJECT_ID 替换为 Google Cloud 项目 ID。

  4. 保存配置。服务器成功连接后,系统会显示绿色的活跃状态。

Cursor

  1. 在项目根目录中创建 .cursor 目录(如果尚不存在)。
  2. 创建 .cursor/mcp.json 文件(如果尚不存在)并打开该文件。
  3. 添加以下配置:

    {
      "mcpServers": {
        "knowledgeCatalog": {
          "command": "./PATH/TO/toolbox",
          "args": ["--prebuilt","dataplex","--stdio"],
          "env": {
            "DATAPLEX_PROJECT": "PROJECT_ID"
          }
        }
      }
    }
    

    PROJECT_ID 替换为 Google Cloud 项目 ID。

  4. 保存配置。

  5. 打开 Cursor,然后依次前往 设置 > Cursor 设置 > 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"
          }
        }
      }
    }
    

    PROJECT_ID 替换为 Google Cloud 项目 ID。

  4. 保存配置。

Windsurf

  1. 打开 Windsurf 并前往 Cascade 助理。
  2. 如需打开配置文件,请点击 MCP 图标,然后点击配置
  3. 添加以下配置:

    {
      "mcpServers": {
        "knowledgeCatalog": {
          "command": "./PATH/TO/toolbox",
          "args": ["--prebuilt","dataplex","--stdio"],
          "env": {
            "DATAPLEX_PROJECT": "PROJECT_ID"
          }
        }
      }
    }
    

    PROJECT_ID 替换为 Google Cloud 项目 ID。

  4. 保存配置。

使用技能

您的 AI 助理现已连接到 Knowledge Catalog。您可以尝试让 AI 助理查找一些数据资产,例如 BigQuery 数据集、Cloud SQL 实例等。

如需查看所有可用技能,请参阅 GitHub 上的 Knowledge Catalog 技能

可选:添加系统指令

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

例如,您可以添加指令来指导 LLM 如何使用 Knowledge Catalog 技能:

  • 当被要求查找数据集或表格时,请使用 search_entries 技能。
  • 如果被要求提供表格架构或元数据详细信息(例如数据质量规则或所有权),请使用 lookup_entry 技能。
  • 当被问及治理规则或分类时,请先使用 search_aspect_types 查找相关切面类型。
  • 如果回答问题需要大量元数据,请使用 lookup_context 技能检索元数据。

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

后续步骤