本页面介绍了如何将 Knowledge Catalog(原 Dataplex Universal Catalog)实例连接到 Antigravity CLI 等开发者工具。将 Knowledge Catalog 连接到这些工具后,您就可以直接在工具中实现 AI 驱动的数据发现和资产管理。
如需使用本地 MCP Toolbox 服务器将数据沿袭连接到开发者工具,请参阅将数据沿袭与本地 MCP Toolbox 服务器搭配使用。
为了获得集成式命令行体验,我们建议使用专用的 Knowledge Catalog 插件(适用于 Antigravity CLI)。 该插件直接将底层技能捆绑到插件中,从而简化了设置和配置。
或者,您也可以使用本地 MCP Toolbox for Databases 连接支持 MCP 的其他 IDE 和开发者工具。您随后可以在现有 IDE 中使用 AI 智能体来发现 Knowledge Catalog 中的数据资产。如需详细了解 MCP,请参阅 Model Context Protocol 简介。
本指南演示了适用于以下工具的连接过程:
- Antigravity CLI(通过插件)
- Antigravity Code Assist
- Claude Code
- Claude Desktop
- Codex
- Cline(VS Code 扩展程序)
- Cursor
- Visual Studio Code (Copilot)
- Windsurf(以前称为 Codeium)
Antigravity CLI 和插件简介
Antigravity CLI 是 Google 提供的开源对话式 AI 代理,可加速开发工作流,并协助完成编码、调试、数据探索和内容创建。它提供了一种由代理驱动的体验,可与 Data Cloud 服务(例如 Knowledge Catalog)以及其他热门开源数据库进行交互。
如需详细了解 Antigravity CLI,请参阅 Antigravity CLI 文档。
Antigravity CLI 插件的工作原理是什么?
插件可扩展 Antigravity CLI 的功能,使其能够连接和控制特定的 Google Cloud 服务和其他工具。它们可为 Antigravity CLI 提供上下文和 API 理解能力,从而实现对话式交互。您可以从 GitHub 网址、本地目录或注册表中加载 Antigravity CLI 插件。这些插件提供了新的技能、斜杠命令和提示。这些插件与使用 MCP Toolbox 集成的 IDE 插件(例如 Antigravity Code Assist)是分开的。
Knowledge Catalog 提供哪些 MCP 工具?
Antigravity CLI 的 Knowledge Catalog 插件可将 AI 集成到数据治理和发现任务中。您可以在终端中使用自然语言提示与 Knowledge Catalog 进行交互。
如需了解所有可用技能,请参阅 GitHub 上的 Knowledge Catalog 技能。
如需详细了解 Knowledge Catalog 插件,请参阅 Antigravity CLI 插件 - Knowledge Catalog。
所需的角色
如需获得使用 MCP Toolbox 或 Antigravity CLI 插件连接到 Knowledge Catalog 所需的权限,请让您的管理员为您授予项目的以下 IAM 角色:
-
启用 API:Service Usage Admin (
roles/serviceusage.serviceUsageAdmin) -
使用 Knowledge Catalog 技能:Dataplex Catalog Viewer (
roles/dataplex.catalogViewer)
如需详细了解如何授予角色,请参阅管理对项目、文件夹和组织的访问权限。
这些预定义角色包含使用 MCP Toolbox 或 Antigravity CLI 插件连接到 Knowledge Catalog 所需的权限。如需查看所需的确切权限,请展开所需权限部分:
所需权限
如需使用 MCP Toolbox 或 Antigravity CLI 插件连接到 Knowledge Catalog,您需要拥有以下权限:
- 启用 API:
serviceusage.services.enable -
如需使用 Knowledge Catalog 技能,请执行以下操作:
-
dataplex.projects.search -
dataplex.entries.get -
dataplex.aspectTypes.get -
dataplex.aspectTypes.list
-
启用 Dataplex API
-
在 Google Cloud 控制台中,前往项目选择器页面。
-
选择或创建 Google Cloud 项目。
选择或创建项目所需的角色
- 选择项目:选择项目不需要特定的 IAM 角色,您可以选择已获授角色的任何项目。
-
创建项目:如需创建项目,您需要拥有 Project Creator 角色 (
roles/resourcemanager.projectCreator),该角色包含resourcemanager.projects.create权限。了解如何授予角色。
启用 Dataplex API(如果尚未启用)。
启用 API 所需的角色
如需启用 API,您需要拥有
serviceusage.services.enable权限。如果您创建了项目,则可能已经通过 Owner 角色 (roles/owner) 拥有此权限。否则,您可以通过 Service Usage Admin 角色 (roles/serviceusage.serviceUsageAdmin) 获得此权限。了解如何授予角色。-
如果您使用的是本地 shell,请为您的用户账号创建本地身份验证凭证:
gcloud auth application-default login
如果您使用的是 Cloud Shell,则无需执行此操作。
如果系统返回身份验证错误,并且您使用的是外部身份提供方 (IdP),请确认您已 使用联合身份登录 gcloud CLI。
安装 MCP Toolbox
如果您只打算使用 Antigravity Code Assist 或 Antigravity CLI 插件,则无需安装 MCP Toolbox,因为它们已捆绑了所需的服务器功能。对于其他 IDE 和工具,请按照本部分中的步骤安装 MCP Toolbox。
以二进制文件形式下载最新版本的 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。将该二进制文件设为可执行文件:
chmod +x toolbox验证安装:
./toolbox --version安装成功后,系统会返回版本号,例如
0.15.0。
设置客户端和连接
本部分介绍了如何将 Knowledge Catalog 连接到您的工具。
如需连接与 MCP 兼容的工具和 IDE,您必须先安装 MCP Toolbox。该工具箱充当位于 IDE 和 Knowledge Catalog 之间的开源 Model Context Protocol (MCP) 服务器,为 AI 工具提供安全高效的控制平面。安装后,请参阅特定工具的部分,了解配置说明。
Antigravity CLI 插件
此方法使用独立 Antigravity CLI 工具的 knowledge-catalog 插件,不使用 MCP Toolbox。
- 安装 Antigravity CLI。
从 GitHub 代码库安装适用于 Antigravity CLI 的 Knowledge Catalog 插件:
agy plugin install https://github.com/gemini-cli-extensions/knowledge-catalog设置环境变量以连接到 Knowledge Catalog 项目:
export DATAPLEX_PROJECT=PROJECT_ID将
PROJECT_ID替换为 Google Cloud项目 ID。以交互模式启动 Antigravity CLI:
agy该 CLI 会自动加载 Knowledge Catalog 插件及其技能,您可以使用这些技能与数据库进行互动。
在 Antigravity CLI 中,使用
/mcp命令验证插件是否已安装。
Antigravity Code Assist
Antigravity Code Assist 捆绑了所需的 MCP 服务器功能,因此您无需单独安装 MCP Toolbox。
- 在 VS Code 中,安装 Antigravity Code Assist 扩展程序。
- 在 Antigravity Code Assist 对话中启用智能体模式。
- 在工作目录中,创建一个名为
.antigravity的文件夹。在该文件夹中,创建一个settings.json文件。 添加以下配置:
{ "mcpServers": { "knowledgeCatalog": { "command": "./PATH/TO/toolbox", "args": ["--prebuilt","dataplex","--stdio"], "env": { "DATAPLEX_PROJECT": "PROJECT_ID" } } } }将
PROJECT_ID替换为 Google Cloud项目 ID。保存配置。
Claude Code
- 安装 Claude Code。
设置环境变量以连接到 Knowledge Catalog 项目:
export DATAPLEX_PROJECT=PROJECT_ID将
PROJECT_ID替换为 Google Cloud项目 ID。启动代理:
claude安装插件:
/plugin install knowledge-catalog@claude-plugins-official
Codex
安装 Data Cloud 插件市场:
codex plugin marketplace add GoogleCloudPlatform/data-cloud-plugins安装 Knowledge Catalog 插件:
codex plugin install dataplex@data-cloud-plugins配置环境变量以连接到 Knowledge Catalog 项目:
export DATAPLEX_PROJECT=PROJECT_ID将
PROJECT_ID替换为 Google Cloud项目 ID。可选。更新市场:
codex plugin marketplace upgrade data-cloud-plugins
Claude Desktop
- 打开 Claude Desktop,然后前往设置。
- 如需打开配置文件,请前往开发者标签页,然后点击修改配置。
添加以下配置:
{ "mcpServers": { "knowledgeCatalog": { "command": "./PATH/TO/toolbox", "args": ["--prebuilt","dataplex","--stdio"], "env": { "DATAPLEX_PROJECT": "PROJECT_ID" } } } }将
PROJECT_ID替换为 Google Cloud项目 ID。保存配置。
重启 Claude Desktop。新聊天界面会显示一个 MCP 图标,代表新的 MCP 服务器。
Cline
- 在 VS Code 中,打开 Cline 扩展程序,然后点击 MCP 服务器图标。
- 如需打开配置文件,请点击配置 MCP 服务器。
添加以下配置:
{ "mcpServers": { "knowledgeCatalog": { "command": "./PATH/TO/toolbox", "args": ["--prebuilt","dataplex","--stdio"], "env": { "DATAPLEX_PROJECT": "PROJECT_ID" } } } }将
PROJECT_ID替换为 Google Cloud项目 ID。保存配置。服务器成功连接后,系统会显示绿色的活跃状态。
光标
- 在项目根目录中创建
.cursor目录(如果尚不存在)。 - 创建
.cursor/mcp.json文件(如果尚不存在)并打开该文件。 添加以下配置:
{ "mcpServers": { "knowledgeCatalog": { "command": "./PATH/TO/toolbox", "args": ["--prebuilt","dataplex","--stdio"], "env": { "DATAPLEX_PROJECT": "PROJECT_ID" } } } }将
PROJECT_ID替换为 Google Cloud项目 ID。保存配置。
打开 Cursor,然后依次前往设置 > Cursor 设置 > MCP。服务器连接时,系统会显示绿色的活跃状态。
VS Code (Copilot)
- 打开 VS Code,并在项目根目录中创建
.vscode目录(如果尚不存在)。 - 创建
.vscode/mcp.json文件(如果尚不存在)并打开该文件。 添加以下配置:
{ "servers": { "knowledgeCatalog": { "command": "./PATH/TO/toolbox", "args": ["--prebuilt","dataplex","--stdio"], "env": { "DATAPLEX_PROJECT": "PROJECT_ID" } } } }将
PROJECT_ID替换为 Google Cloud项目 ID。保存配置。
Windsurf
- 打开 Windsurf 并前往 Cascade 设置。
- 如需打开配置文件,请点击 MCP 图标,然后点击配置。
添加以下配置:
{ "mcpServers": { "knowledgeCatalog": { "command": "./PATH/TO/toolbox", "args": ["--prebuilt","dataplex","--stdio"], "env": { "DATAPLEX_PROJECT": "PROJECT_ID" } } } }将
PROJECT_ID替换为 Google Cloud项目 ID。保存配置。
使用技能
您的 AI 助理现已连接到 Knowledge Catalog。您可以尝试让 AI 助理查找一些数据资产,例如 BigQuery 数据集、Cloud SQL 实例等。
如需了解所有可用技能,请参阅 GitHub 上的知识目录技能。
可选:添加系统指令
系统指令可用于为 LLM 提供特定准则,帮助其了解上下文并更准确地回答问题。根据推荐的系统提示设置系统指令。
例如,您可以添加指令,指导 LLM 如何使用 Knowledge Catalog skill:
- 当系统要求查找数据集或表时,请使用
search_entries技能。 - 如果系统要求提供表架构或元数据详细信息(例如数据质量规则或所有权),请使用
lookup_entry技能。 - 当被问及治理规则或分类时,首先使用
search_aspect_types查找相关的切面类型。 - 如果回答问题需要大量元数据,请使用
lookup_context技能来检索这些元数据。
如需详细了解如何配置指令,请参阅使用指令获取符合您编码风格的 AI 编辑内容。
后续步骤
- 了解如何使用本地 MCP Toolbox 服务器进行数据沿袭。
- 查看本地 MCP 服务器和远程 MCP 服务器之间的区别。
- 请参阅使用 Antigravity CLI 测试数据上下文应用场景。
- 阅读Knowledge Catalog MCP 工具参考文档和数据沿袭 MCP 工具参考文档。
- 在 Knowledge Catalog 中搜索资源。
- 了解如何将自定义来源注入到 Knowledge Catalog 中。
- 了解如何管理切面和丰富元数据。