Usar o Dataplex Universal Catalog com o MCP, o Gemini e outros agentes

Nesta página, explicamos como conectar sua instância do Dataplex Universal Catalog a ferramentas de desenvolvedor, como a CLI Gemini. Ao conectar o Dataplex Universal Catalog a essas ferramentas, você ativa a descoberta de dados e o gerenciamento de recursos com tecnologia de IA diretamente no seu ambiente de desenvolvimento integrado.

Para uma experiência integrada de linha de comando, recomendamos usar a extensão dedicada do Dataplex Universal Catalog para a CLI do Gemini. A extensão agrupa o servidor do Protocolo de Contexto de Modelo (MCP) subjacente, que atua como um intermediário entre a CLI do Gemini e o Dataplex Universal Catalog, eliminando a necessidade de uma configuração de servidor separada.

Como alternativa, conecte outros IDEs e ferramentas de desenvolvedor que oferecem suporte ao MCP usando a MCP Toolbox for Databases (link em inglês) de uso geral. Em seguida, use agentes de IA no seu ambiente de desenvolvimento integrado para descobrir recursos de dados no Dataplex Universal Catalog. Para mais informações sobre o MCP, consulte Introdução ao protocolo de contexto de modelo.

Este guia demonstra o processo de conexão das seguintes ferramentas:

Sobre a CLI do Gemini e as extensões

A CLI do Gemini é um agente de IA conversacional de código aberto do Google que acelera os fluxos de trabalho de desenvolvimento e ajuda na programação, depuração, análise de dados e criação de conteúdo. Ele oferece uma experiência orientada por agente para interagir com serviços da Data Cloud, como o Dataplex Universal Catalog, e outros bancos de dados de código aberto populares.

Para mais informações sobre a CLI do Gemini, consulte a documentação da CLI do Gemini.

Como as extensões funcionam

As extensões aumentam as capacidades da CLI do Gemini, permitindo que ela se conecte e controle serviços Google Cloud específicos e outras ferramentas. Eles fornecem contexto e compreensão da API ao Gemini, permitindo a interação por conversa. É possível carregar extensões da CLI do Gemini de URLs do GitHub, diretórios locais ou registros. Essas extensões oferecem novas ferramentas, comandos de barra e solicitações. Elas são separadas das extensões de ambiente de desenvolvimento integrado, como o Gemini Code Assist, que se integra usando a caixa de ferramentas do MCP.

Sobre a extensão do Dataplex Universal Catalog

A caixa de ferramentas do MCP para bancos de dados está na versão Beta (pré-v1.0) e pode ter mudanças significativas até o primeiro lançamento estável (v1.0).

A extensão do Dataplex Universal Catalog para a CLI do Gemini integra a IA às suas tarefas de governança e descoberta de dados. Você pode interagir com o Dataplex Universal Catalog usando comandos em linguagem natural no terminal. Confira alguns exemplos:

Categoria Ferramenta Exemplo de comando de linguagem natural
Descoberta e governança de dados dataplex_search_entries
  • Encontre todos os conjuntos de dados relacionados a vendas na Europa.
  • Mostre as tabelas que contêm PIIs de clientes.
  • Liste todos os conjuntos de dados do BigQuery no lake "marketing" do Dataplex Universal Catalog.
dataplex_lookup_entry
  • Qual é o esquema da tabela "pedidos"?
  • Descrever as regras de qualidade de dados aplicadas ao banco de dados de clientes.
  • Quem está listado como proprietário da empresa na tabela "customer_details"?
dataplex_search_aspect_types
  • Mostre os tipos de aspectos relacionados às regras de qualidade de dados.
  • Liste todos os tipos de aspectos usados para governança de dados.
  • Há algum tipo de aspecto para marcar dados de PII?

Para mais informações sobre a extensão do Dataplex Universal Catalog, consulte a Extensão da CLI do Gemini: Dataplex Universal Catalog.

Papéis e permissões necessárias

Para receber as permissões necessárias para se conectar ao Catálogo universal do Dataplex usando a caixa de ferramentas do MCP ou a extensão da CLI do Gemini, peça ao administrador para conceder a você os seguintes papéis do IAM no projeto:

Para mais informações sobre a concessão de papéis, consulte Gerenciar o acesso a projetos, pastas e organizações.

Esses papéis predefinidos contêm as permissões necessárias para se conectar ao catálogo universal do Dataplex usando a caixa de ferramentas do MCP ou a extensão da CLI do Gemini. Para acessar as permissões exatas necessárias, expanda a seção Permissões necessárias:

Permissões necessárias

As seguintes permissões são necessárias para se conectar ao Dataplex Universal Catalog usando a caixa de ferramentas do MCP ou a 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

Essas permissões também podem ser concedidas com funções personalizadas ou outros papéis predefinidos.

Ativar a API Dataplex Universal Catalog

  1. Revise as permissões necessárias para concluir as tarefas neste guia.
  2. In the Google Cloud console, go to the project selector page.

    Go to project selector

  3. 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 the resourcemanager.projects.create permission. Learn how to grant roles.
  4. Verify that billing is enabled for your Google Cloud project.

  5. 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 the serviceusage.services.enable permission. Learn how to grant roles.

    Enable the API

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

Instalar a caixa de ferramentas do MCP

Não é necessário instalar a caixa de ferramentas do MCP se você planeja usar apenas o Gemini Code Assist ou a extensão da CLI do Gemini, já que eles agrupam os recursos necessários do servidor. Para outros ambientes de desenvolvimento integrado e ferramentas, siga as etapas desta seção para instalar a caixa de ferramentas do MCP.

  1. Faça o download da versão mais recente da MCP Toolbox como um binário. Selecione o binário que corresponde ao seu sistema operacional e arquitetura de CPU. Use a caixa de ferramentas do MCP v0.15.0 ou mais recente.

    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.

  2. Torne o binário executável:

    chmod +x toolbox
    
  3. Verifique a instalação:

    ./toolbox --version
    

    Uma instalação bem-sucedida retorna o número da versão, por exemplo, 0.15.0.

Configurar clientes e conexões

Nesta seção, explicamos como conectar o Dataplex Universal Catalog às suas ferramentas.

Se você estiver usando o Gemini Code Assist ou a CLI independente do Gemini, não será necessário instalar nem configurar a caixa de ferramentas do MCP, já que essas ferramentas incluem os recursos necessários do servidor. Para instruções de configuração, consulte as guias "Extensão do Gemini Code Assist" ou "CLI do Gemini".

Para outras ferramentas e ambientes de desenvolvimento integrado compatíveis com o MCP, primeiro é preciso instalar a caixa de ferramentas do MCP. A caixa de ferramentas funciona como um servidor Protocolo de Contexto de Modelo (MCP) de código aberto que fica entre seu ambiente de desenvolvimento integrado (IDE) e o Dataplex Universal Catalog, fornecendo um plano de controle seguro e eficiente para suas ferramentas de IA. Depois da instalação, selecione a guia da sua ferramenta específica para ver as instruções de configuração.

Extensão da CLI do Gemini

Esse método usa a extensão dataplex dedicada para a ferramenta CLI independente do Gemini e não usa a caixa de ferramentas do MCP.

  1. Instale a CLI do Gemini.
  2. Instale a extensão do catálogo universal do Dataplex para a CLI Gemini no repositório do GitHub:
    gemini extensions install https://github.com/gemini-cli-extensions/dataplex
  3. Defina a variável de ambiente para se conectar ao projeto do Dataplex Universal Catalog:
    export DATAPLEX_PROJECT="PROJECT_ID"

    Substitua PROJECT_ID pelo ID do projeto Google Cloud .

  4. Inicie a CLI do Gemini no modo interativo:
    gemini
    A CLI carrega automaticamente a extensão do Dataplex Universal Catalog e as ferramentas dela, que você pode usar para interagir com seus recursos de dados.

Gemini Code Assist

O Gemini Code Assist agrupa os recursos necessários do servidor MCP, então não é preciso instalar a caixa de ferramentas do MCP separadamente.

  1. No VS Code, instale a extensão Gemini Code Assist.
  2. Ative o Modo Agente no chat do Gemini Code Assist.
  3. No diretório de trabalho, crie uma pasta chamada .gemini. Nele, crie um arquivo settings.json.
  4. Adicione a seguinte configuração, substitua as variáveis de ambiente pelos seus valores e salve:
      {
        "mcpServers": {
          "dataplex": {
            "command": "./PATH/TO/toolbox",
            "args": ["--prebuilt","dataplex","--stdio"],
            "env": {
              "DATAPLEX_PROJECT": "PROJECT_ID"
            }
          }
        }
      }
      

Código do Claude

  1. Instale o Claude Code.
  2. Crie o arquivo .mcp.json na raiz do projeto, se ele não existir.
  3. Adicione a configuração, substitua as variáveis de ambiente pelos seus valores e salve:
      {
        "mcpServers": {
          "dataplex": {
            "command": "./PATH/TO/toolbox",
            "args": ["--prebuilt","dataplex","--stdio"],
            "env": {
              "DATAPLEX_PROJECT": "PROJECT_ID"
            }
          }
        }
      }
      

Claude para computador

  1. Abra o Claude para computador e acesse Configurações.
  2. Para abrir o arquivo de configuração, na guia Desenvolvedor, clique em Editar configuração.
  3. Adicione a configuração, substitua as variáveis de ambiente pelos seus valores e salve:
      {
        "mcpServers": {
          "dataplex": {
            "command": "./PATH/TO/toolbox",
            "args": ["--prebuilt","dataplex","--stdio"],
            "env": {
              "DATAPLEX_PROJECT": "PROJECT_ID"
            }
          }
        }
      }
      
  4. Reinicie o Claude para computador.
    A nova tela de chat mostra um ícone do MCP com o novo servidor.

Cline

  1. No VS Code, abra a extensão Cline e clique no ícone Servidores MCP.
  2. Para abrir o arquivo de configuração, toque em Configurar servidores MCP.
  3. Adicione a seguinte configuração, substitua as variáveis de ambiente pelos seus valores e salve:
      {
        "mcpServers": {
          "dataplex": {
            "command": "./PATH/TO/toolbox",
            "args": ["--prebuilt","dataplex","--stdio"],
            "env": {
              "DATAPLEX_PROJECT": "PROJECT_ID"
            }
          }
        }
      }
      
    Um status ativo verde aparece depois que o servidor se conecta.

Cursor

  1. Crie o diretório .cursor na raiz do projeto se ele não existir.
  2. Crie o arquivo .cursor/mcp.json, se ele não existir, e abra-o.
  3. Adicione a seguinte configuração, substitua as variáveis de ambiente pelos seus valores e salve:
      {
        "mcpServers": {
          "dataplex": {
            "command": "./PATH/TO/toolbox",
            "args": ["--prebuilt","dataplex","--stdio"],
            "env": {
              "DATAPLEX_PROJECT": "PROJECT_ID"
            }
          }
        }
      }
      
  4. Abra Cursor e acesse Configurações>Configurações do cursor > MCP. Um status ativo verde aparece quando o servidor se conecta.

VS Code (Copilot)

  1. Abra o VS Code e crie o diretório .vscode na raiz do projeto, se ele não existir.
  2. Crie o arquivo .vscode/mcp.json, se ele não existir, e abra-o.
  3. Adicione a seguinte configuração, substitua as variáveis de ambiente pelos seus valores e salve:
      {
        "servers": {
          "dataplex": {
            "command": "./PATH/TO/toolbox",
            "args": ["--prebuilt","dataplex","--stdio"],
            "env": {
              "DATAPLEX_PROJECT": "PROJECT_ID"
            }
          }
        }
      }
      

Windsurf

  1. Abra o Windsurf e navegue até o assistente do Cascade.
  2. Para abrir o arquivo de configuração, clique no ícone do MCP e em Configurar.
  3. Adicione a seguinte configuração, substitua as variáveis de ambiente pelos seus valores e salve:
      {
        "mcpServers": {
          "dataplex": {
            "command": "./PATH/TO/toolbox",
            "args": ["--prebuilt","dataplex","--stdio"],
            "env": {
              "DATAPLEX_PROJECT": "PROJECT_ID"
            }
          }
        }
      }
      

Usar as ferramentas

Sua ferramenta de IA agora está conectada ao Dataplex Universal Catalog. Peça ao 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 LLM:

Opcional: adicione instruções do sistema

As instruções do sistema são uma maneira de fornecer diretrizes específicas ao LLM, ajudando-o a entender o contexto e responder com mais precisão. Defina instruções do sistema com base no comando de sistema recomendado.

Por exemplo, é possível adicionar instruções para orientar o LLM sobre como usar as ferramentas do Dataplex Universal Catalog:

  • Quando for solicitado a encontrar conjuntos de dados ou tabelas, use a ferramenta dataplex_search_entries.
  • Se for solicitado o esquema da tabela ou detalhes de metadados, como regras de qualidade de dados ou propriedade, use a ferramenta dataplex_lookup_entry.
  • Quando perguntado sobre regras ou classificações de governança, comece usando dataplex_search_aspect_types para encontrar tipos de aspectos relevantes.

Para mais informações sobre como configurar instruções, consulte Usar instruções para receber edições de IA que seguem seu estilo de programação.

A seguir