Esta página explica como associar a sua instância do catálogo universal do Dataplex a ferramentas de programador, como a CLI do Gemini. A associação do catálogo universal do Dataplex a estas ferramentas permite a descoberta de dados e a gestão de recursos baseadas em IA diretamente no seu IDE.
Para uma experiência de linha de comandos integrada, recomendamos que use a extensão Dataplex Universal Catalog dedicada para a CLI Gemini. A extensão agrupa o servidor do protocolo de contexto do modelo (MCP) subjacente, que funciona como intermediário entre a CLI Gemini e o Dataplex Universal Catalog, eliminando a necessidade de uma configuração de servidor separada.
Em alternativa, pode ligar outros IDEs e ferramentas para programadores que suportem o MCP através da caixa de ferramentas do MCP para bases de dados de uso geral. Em seguida, pode usar agentes de IA no seu IDE existente para descobrir recursos de dados no catálogo universal do Dataplex. Para mais informações sobre o MCP, consulte o artigo Introdução ao protocolo de contexto do modelo.
Este guia demonstra o processo de associação para as seguintes ferramentas:
- CLI do Gemini (através de extensão)
- Gemini Code Assist
- Código Claude
- Claude para computador
- Cline (extensão do VS Code)
- Cursor
- Visual Studio Code (Copilot)
- Windsurf (anteriormente Codeium)
Acerca da CLI do Gemini e das extensões
A CLI Gemini é um agente de IA de conversação de código aberto da Google que acelera os fluxos de trabalho de desenvolvimento e ajuda na programação, na depuração, na exploração de dados e na criação de conteúdo. Oferece uma experiência orientada por um agente para interagir com os serviços do Data Cloud, como o Dataplex Universal Catalog, e outras bases de dados populares de código aberto.
Para mais informações sobre a CLI do Gemini, consulte a documentação da CLI do Gemini.
Como funcionam as extensões
As extensões expandem as capacidades da CLI Gemini, permitindo-lhe ligar-se e controlar serviços específicos e outras ferramentas. Google Cloud Fornecem contexto e compreensão da API ao Gemini, o que permite a interação conversacional. Pode carregar extensões da CLI do Gemini a partir de URLs do GitHub, diretórios locais ou registos. Estas extensões oferecem novas ferramentas, comandos com barra e comandos. Estas são separadas das extensões do IDE, como o Gemini Code Assist, que se integram através da caixa de ferramentas do MCP.
Acerca da extensão do Dataplex Universal Catalog
A caixa de ferramentas do MCP para bases de dados está em versão beta (pré-v1.0) e pode sofrer alterações significativas até ao primeiro lançamento estável (v1.0).
A extensão do catálogo universal do Dataplex para a CLI do Gemini integra a IA nas suas tarefas de governação e deteção de dados. Pode interagir com o Dataplex Universal Catalog através de comandos de linguagem natural no seu terminal. Seguem-se alguns exemplos:
Categoria | Ferramenta | Exemplo de comando de linguagem natural |
---|---|---|
Descoberta e gestão de dados | dataplex_search_entries |
|
dataplex_lookup_entry |
|
|
dataplex_search_aspect_types |
|
Para mais informações sobre a extensão Dataplex Universal Catalog, consulte o artigo Extensão da CLI do Gemini – Dataplex Universal Catalog.
Funções e autorizações necessárias
Para receber as autorizações de que precisa para estabelecer ligação ao catálogo universal do Dataplex através da MCP Toolbox ou da extensão da CLI do Gemini, peça ao seu administrador para lhe conceder as seguintes funções do IAM no seu projeto:
-
Para ativar as APIs:
Administrador de utilização de serviços (
roles/serviceusage.serviceUsageAdmin
) -
Para usar as ferramentas do Dataplex Universal Catalog:
Visualizador do catálogo do Dataplex (
roles/dataplex.catalogViewer
)
Para mais informações sobre a atribuição de funções, consulte o artigo Faça a gestão do acesso a projetos, pastas e organizações.
Estas funções predefinidas contêm as autorizações necessárias para estabelecer ligação ao catálogo universal do Dataplex através da caixa de ferramentas do MCP ou da extensão da CLI do Gemini. Para ver as autorizações exatas que são necessárias, expanda a secção Autorizações necessárias:
Autorizações necessárias
As seguintes autorizações são necessárias para estabelecer ligação ao Dataplex Universal Catalog através da MCP Toolbox ou da extensão da CLI do Gemini:
-
Para ativar APIs:
serviceusage.services.enable
-
Para usar as ferramentas do Dataplex Universal Catalog:
-
dataplex.projects.search
-
dataplex.entries.get
-
dataplex.aspectTypes.get
-
dataplex.aspectTypes.list
-
Também pode conseguir estas autorizações com funções personalizadas ou outras funções predefinidas.
Ative a API Dataplex Universal Catalog
- Reveja as autorizações necessárias para concluir as tarefas neste guia.
-
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.
Instale a caixa de ferramentas do MCP
Não precisa de instalar a caixa de ferramentas do MCP se planear usar apenas o Gemini Code Assist ou a extensão da CLI do Gemini, uma vez que incluem as capacidades de servidor necessárias. Para outros IDEs e ferramentas, siga os passos nesta secção para instalar a MCP Toolbox.
Transfira a versão mais recente da MCP Toolbox como um ficheiro binário. Selecione o binário que corresponde à arquitetura do seu SO e CPU. Tem de usar a MCP Toolbox v0.15.0 ou posterior.
Linux/amd64
curl -O https://storage.googleapis.com/genai-toolbox/VERSION/linux/amd64/toolbox
Substitua
VERSION
pela versão da caixa de ferramentas do MCP, por exemplo,v0.15.0
.macOS (Darwin)/arm64
curl -O https://storage.googleapis.com/genai-toolbox/VERSION/darwin/arm64/toolbox
Substitua
VERSION
pela versão da caixa de ferramentas do MCP, por exemplo,v0.15.0
.macOS (Darwin)/amd64
curl -O https://storage.googleapis.com/genai-toolbox/VERSION/darwin/amd64/toolbox
Substitua
VERSION
pela versão da caixa de ferramentas do MCP, por exemplo,v0.15.0
.Windows/amd64
curl -O https://storage.googleapis.com/genai-toolbox/VERSION/windows/amd64/toolbox
Substitua
VERSION
pela versão da caixa de ferramentas do MCP, por exemplo,v0.15.0
.Torne o executável binário:
chmod +x toolbox
Valide a instalação:
./toolbox --version
Uma instalação bem-sucedida devolve o número da versão, por exemplo, 0.15.0.
Configure clientes e associações
Esta secção explica como associar o Dataplex Universal Catalog às suas ferramentas.
Se estiver a usar o Gemini Code Assist ou a CLI Gemini autónoma, não precisa de instalar nem configurar o MCP Toolbox, uma vez que estas ferramentas incluem as capacidades do servidor necessárias. Para obter instruções de configuração, consulte os separadores Gemini Code Assist ou extensão da CLI do Gemini.
Para outras ferramentas e IDEs compatíveis com o MCP, tem de instalar primeiro o MCP Toolbox. A caixa de ferramentas funciona como um servidor de protocolo Model Context Protocol (MCP) de código aberto que se encontra entre o seu IDE e o Dataplex Universal Catalog, oferecendo um plano de controlo seguro e eficiente para as suas ferramentas de IA. Após a instalação, selecione o separador da sua ferramenta específica para ver as instruções de configuração.
Extensão da CLI do Gemini
Este método usa a extensão dataplex
dedicada para a ferramenta Gemini CLI autónoma e não usa a MCP Toolbox.
- Instale a CLI do Gemini.
- Instale a extensão Dataplex Universal Catalog para a CLI Gemini a partir do repositório GitHub:
gemini extensions install https://github.com/gemini-cli-extensions/dataplex
- Defina a variável de ambiente para se ligar ao seu projeto do Dataplex Universal Catalog:
export DATAPLEX_PROJECT="PROJECT_ID"
Substitua
PROJECT_ID
pelo ID do seu Google Cloud projeto. - Inicie a CLI do Gemini no modo interativo:
A CLI carrega automaticamente a extensão do catálogo universal do Dataplex e as respetivas ferramentas, que pode usar para interagir com os seus recursos de dados.gemini
Gemini Code Assist
O Gemini Code Assist inclui as capacidades do servidor MCP necessárias, pelo que não precisa de instalar a caixa de ferramentas do MCP separadamente.
- No VS Code, instale a extensão Gemini Code Assist.
- Ative o modo de agente no chat do Gemini Code Assist.
- No seu diretório de trabalho, crie uma pasta denominada
.gemini
. Dentro dessa pasta, crie um ficheirosettings.json
. - Adicione a seguinte configuração, substitua as variáveis de ambiente pelos seus valores e guarde:
{ "mcpServers": { "dataplex": { "command": "./PATH/TO/toolbox", "args": ["--prebuilt","dataplex","--stdio"], "env": { "DATAPLEX_PROJECT": "PROJECT_ID" } } } }
Código do Claude
- Instale o Claude Code.
- Crie o ficheiro
.mcp.json
na raiz do projeto, se não existir. - Adicione a configuração, substitua as variáveis de ambiente pelos seus valores e guarde:
{ "mcpServers": { "dataplex": { "command": "./PATH/TO/toolbox", "args": ["--prebuilt","dataplex","--stdio"], "env": { "DATAPLEX_PROJECT": "PROJECT_ID" } } } }
Claude para computador
- Abra o Claude Desktop e navegue para Definições.
- Para abrir o ficheiro de configuração, no separador Programador, clique em Editar config.
- Adicione a configuração, substitua as variáveis de ambiente pelos seus valores e guarde:
{ "mcpServers": { "dataplex": { "command": "./PATH/TO/toolbox", "args": ["--prebuilt","dataplex","--stdio"], "env": { "DATAPLEX_PROJECT": "PROJECT_ID" } } } }
- Reinicie o Claude para computador.
O novo ecrã de chat apresenta um ícone de MCP com o novo servidor de MCP.
Cline
- No VS Code, abra a extensão Cline e, de seguida, clique no ícone Servidores MCP.
- Para abrir o ficheiro de configuração, toque em Configurar servidores MCP.
- Adicione a seguinte configuração, substitua as variáveis de ambiente pelos seus valores e guarde:
É apresentado um estado ativo verde depois de o servidor se ligar com êxito.{ "mcpServers": { "dataplex": { "command": "./PATH/TO/toolbox", "args": ["--prebuilt","dataplex","--stdio"], "env": { "DATAPLEX_PROJECT": "PROJECT_ID" } } } }
Cursor
- Crie o diretório
.cursor
na raiz do projeto, se ainda não existir. - Crie o ficheiro
.cursor/mcp.json
se não existir e abra-o. - Adicione a seguinte configuração, substitua as variáveis de ambiente pelos seus valores e guarde:
{ "mcpServers": { "dataplex": { "command": "./PATH/TO/toolbox", "args": ["--prebuilt","dataplex","--stdio"], "env": { "DATAPLEX_PROJECT": "PROJECT_ID" } } } }
- Abra o Cursor e navegue para Definições>Definições do cursor > MCP. É apresentado um estado ativo verde quando o servidor se liga.
VS Code (Copilot)
- Abra o VS Code e crie o diretório
.vscode
na raiz do projeto, se ainda não existir. - Crie o ficheiro
.vscode/mcp.json
se não existir e abra-o. - Adicione a seguinte configuração, substitua as variáveis de ambiente pelos seus valores e guarde:
{ "servers": { "dataplex": { "command": "./PATH/TO/toolbox", "args": ["--prebuilt","dataplex","--stdio"], "env": { "DATAPLEX_PROJECT": "PROJECT_ID" } } } }
Windsurf
- Abra o Windsurf e navegue para o assistente Cascade.
- Para abrir o ficheiro de configuração, clique no ícone do MCP e, de seguida, clique em Configurar.
- Adicione a seguinte configuração, substitua as variáveis de ambiente pelos seus valores e guarde:
{ "mcpServers": { "dataplex": { "command": "./PATH/TO/toolbox", "args": ["--prebuilt","dataplex","--stdio"], "env": { "DATAPLEX_PROJECT": "PROJECT_ID" } } } }
Use as ferramentas
A sua ferramenta de IA está agora ligada ao catálogo universal do Dataplex. Experimente pedir ao seu assistente de IA para encontrar alguns recursos de dados, como conjuntos de dados do BigQuery, instâncias do Cloud SQL e outros.
As seguintes ferramentas estão disponíveis para o MDG:
- dataplex_search_entries: pesquise recursos de dados
- dataplex_lookup_entry: obtenha metadados (por exemplo, esquema, utilização, vista geral da empresa e contactos) de recursos de dados
- dataplex_search_aspect_types: pesquisa de tipos de aspetos
Opcional: adicione instruções do sistema
As instruções do sistema são uma forma de fornecer diretrizes específicas ao GML, ajudando-o a compreender o contexto e a responder com maior precisão. Configure as instruções do sistema com base no comando do sistema recomendado.
Por exemplo, pode adicionar instruções para orientar o MDG sobre como usar as ferramentas do Dataplex Universal Catalog:
- Quando lhe for pedido que encontre conjuntos de dados ou tabelas, use a ferramenta
dataplex_search_entries
. - Se lhe forem solicitados detalhes do esquema da tabela ou metadados, como regras de qualidade dos dados ou propriedade, use a ferramenta
dataplex_lookup_entry
. - Quando lhe perguntarem sobre regras de governação ou classificações, comece por usar
dataplex_search_aspect_types
para encontrar tipos de aspetos relevantes.
Para mais informações sobre como configurar instruções, consulte o artigo Use instruções para obter edições de IA que seguem o seu estilo de programação.
O que se segue?
- Saiba mais sobre a pesquisa no catálogo do Dataplex Universal Catalog.
- Saiba como carregar origens personalizadas no Dataplex Universal Catalog.
- Saiba como gerir metadados através de tipos de aspetos.