Usa Dataplex Universal Catalog con MCP, Gemini y otros agentes

En esta página, se explica cómo conectar tu instancia de Dataplex Universal Catalog a herramientas para desarrolladores, como la CLI de Gemini. Conectar Dataplex Universal Catalog a estas herramientas permite el descubrimiento de datos y la administración de recursos basados en IA directamente en tu IDE.

Para una experiencia de línea de comandos integrada, te recomendamos que uses la extensión dedicada de Dataplex Universal Catalog para Gemini CLI. La extensión incluye el servidor subyacente del Protocolo de contexto del modelo (MCP), que actúa como intermediario entre la CLI de Gemini y Dataplex Universal Catalog, lo que elimina la necesidad de configurar un servidor independiente.

Como alternativa, puedes conectar otros IDE y herramientas para desarrolladores que admitan MCP con el kit de herramientas de MCP para bases de datos de uso general. Luego, puedes usar agentes de IA en tu IDE existente para descubrir recursos de datos en Dataplex Universal Catalog. Para obtener más información sobre el MCP, consulta Introducción al Protocolo de contexto del modelo.

En esta guía, se muestra el proceso de conexión de las siguientes herramientas:

Acerca de la CLI de Gemini y las extensiones

La CLI de Gemini es un agente de IA conversacional de código abierto de Google que acelera los flujos de trabajo de desarrollo y ayuda con la programación, la depuración, la exploración de datos y la creación de contenido. Ofrece una experiencia basada en agentes para interactuar con los servicios de Data Cloud, como Dataplex Universal Catalog, y otras bases de datos de código abierto populares.

Para obtener más información sobre Gemini CLI, consulta la documentación de Gemini CLI.

Cómo funcionan las extensiones

Las extensiones amplían las capacidades de la CLI de Gemini, lo que le permite conectarse a servicios Google Cloud específicos y otras herramientas, y controlarlos. Proporcionan a Gemini contexto y comprensión de la API, lo que permite la interacción conversacional. Puedes cargar extensiones de Gemini CLI desde URLs de GitHub, directorios locales o registros. Estas extensiones ofrecen nuevas herramientas, comandos de barra y mensajes de instrucción. Son diferentes de las extensiones del IDE, como Gemini Code Assist, que se integran con MCP Toolbox.

Acerca de la extensión de Dataplex Universal Catalog

MCP Toolbox for Databases se encuentra en versión beta (anterior a la v1.0) y es posible que sufra cambios rotundos hasta el lanzamiento de la primera versión estable (v1.0).

La extensión de Dataplex Universal Catalog para la CLI de Gemini integra la IA en tus tareas de administración y descubrimiento de datos. Puedes interactuar con Dataplex Universal Catalog usando instrucciones en lenguaje natural en tu terminal. Estos son algunos ejemplos:

Categoría Herramienta Ejemplo de instrucción en lenguaje natural
Descubrimiento y administración de datos dataplex_search_entries
  • Encuentra todos los conjuntos de datos relacionados con las ventas en Europa.
  • Muéstrame las tablas que contienen PII del cliente.
  • Enumera todos los conjuntos de datos de BigQuery en el lake "marketing" en Dataplex Universal Catalog.
dataplex_lookup_entry
  • ¿Cuál es el esquema de la tabla “orders”?
  • Describe las reglas de calidad de los datos que se aplican a la base de datos de clientes.
  • ¿Quién aparece como propietario de la empresa en la tabla `customer_details`?
dataplex_search_aspect_types
  • Muéstrame los tipos de aspectos relacionados con las reglas de calidad de los datos.
  • Enumera todos los tipos de aspectos que se usan para la administración de datos.
  • ¿Hay algún tipo de aspecto para marcar los datos de PII?

Para obtener más información sobre la extensión de Dataplex Universal Catalog, consulta la extensión de Gemini CLI: Dataplex Universal Catalog.

Roles y permisos requeridos

Para obtener los permisos que necesitas para conectarte al catálogo universal de Dataplex con MCP Toolbox o la extensión de la CLI de Gemini, pídele a tu administrador que te otorgue los siguientes roles de IAM en tu proyecto:

Para obtener más información sobre cómo otorgar roles, consulta Administra el acceso a proyectos, carpetas y organizaciones.

Estos roles predefinidos contienen los permisos necesarios para conectarse al catálogo universal de Dataplex con MCP Toolbox o la extensión de la CLI de Gemini. Para ver los permisos exactos que son necesarios, expande la sección Permisos requeridos:

Permisos necesarios

Se requieren los siguientes permisos para conectarse a Dataplex Universal Catalog con MCP Toolbox o la extensión de la CLI de Gemini:

  • Para habilitar las APIs, sigue estos pasos: serviceusage.services.enable
  • Para usar las herramientas de Dataplex Universal Catalog, haz lo siguiente:
    • dataplex.projects.search
    • dataplex.entries.get
    • dataplex.aspectTypes.get
    • dataplex.aspectTypes.list

También puedes obtener estos permisos con roles personalizados o con otros roles predefinidos.

Habilita la API de Dataplex Universal Catalog

  1. Revisa los permisos necesarios para completar las tareas de esta guía.
  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 role (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.

Instala MCP Toolbox

No es necesario que instales MCP Toolbox si solo planeas usar Gemini Code Assist o la extensión de la CLI de Gemini, ya que incluyen las capacidades del servidor necesarias. Para otros IDE y herramientas, sigue los pasos de esta sección para instalar MCP Toolbox.

  1. Descarga la versión más reciente de MCP Toolbox como un archivo binario. Selecciona el objeto binario que corresponda a tu sistema operativo y arquitectura de CPU. Debes usar MCP Toolbox v0.15.0 o una versión posterior.

    Linux/amd64

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

    Reemplaza VERSION por la versión de MCP Toolbox, por ejemplo, v0.15.0.

    macOS (Darwin)/arm64

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

    Reemplaza VERSION por la versión de MCP Toolbox, por ejemplo, v0.15.0.

    macOS (Darwin)/amd64

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

    Reemplaza VERSION por la versión de MCP Toolbox, por ejemplo, v0.15.0.

    Windows/amd64

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

    Reemplaza VERSION por la versión de MCP Toolbox, por ejemplo, v0.15.0.

  2. Haz que el objeto binario sea ejecutable:

    chmod +x toolbox
    
  3. Verifica la instalación:

    ./toolbox --version
    

    Si la instalación se realiza correctamente, se muestra el número de versión, por ejemplo, 0.15.0.

Configura clientes y conexiones

En esta sección, se explica cómo conectar Dataplex Universal Catalog a tus herramientas.

Si usas Gemini Code Assist o la CLI de Gemini independiente, no necesitas instalar ni configurar MCP Toolbox, ya que estas herramientas incluyen las capacidades del servidor necesarias. Para obtener instrucciones de configuración, consulta las pestañas de la extensión de Gemini Code Assist o de la CLI de Gemini.

Para otras herramientas y otros IDE compatibles con MCP, primero debes instalar MCP Toolbox. La caja de herramientas actúa como un servidor de Protocolo de contexto del modelo (MCP) de código abierto que se encuentra entre tu IDE y Dataplex Universal Catalog, y proporciona un plano de control seguro y eficiente para tus herramientas de IA. Después de la instalación, selecciona la pestaña de tu herramienta específica para ver las instrucciones de configuración.

Extensión de la CLI de Gemini

Este método usa la extensión dataplex dedicada para la herramienta independiente de la CLI de Gemini y no usa MCP Toolbox.

  1. Instala la CLI de Gemini.
  2. Instala la extensión del catálogo universal de Dataplex para la CLI de Gemini desde el repositorio de GitHub:
    gemini extensions install https://github.com/gemini-cli-extensions/dataplex
  3. Establece la variable de entorno para conectarte a tu proyecto de Dataplex Universal Catalog:
    export DATAPLEX_PROJECT="PROJECT_ID"

    Reemplaza PROJECT_ID por el Google Cloud ID del proyecto.

  4. Inicia Gemini CLI en modo interactivo:
    gemini
    La CLI carga automáticamente la extensión de Dataplex Universal Catalog y sus herramientas, que puedes usar para interactuar con tus recursos de datos.

Gemini Code Assist

Gemini Code Assist incluye las capacidades necesarias del servidor de MCP, por lo que no es necesario que instales MCP Toolbox por separado.

  1. En VS Code, instala la extensión de Gemini Code Assist.
  2. Habilita el modo de agente en el chat de Gemini Code Assist.
  3. En tu directorio de trabajo, crea una carpeta llamada .gemini. Dentro de ese directorio, crea un archivo settings.json.
  4. Agrega la siguiente configuración, reemplaza las variables de entorno por tus valores y guarda los cambios:
      {
        "mcpServers": {
          "dataplex": {
            "command": "./PATH/TO/toolbox",
            "args": ["--prebuilt","dataplex","--stdio"],
            "env": {
              "DATAPLEX_PROJECT": "PROJECT_ID"
            }
          }
        }
      }
      

Claude Code

  1. Instala Claude Code.
  2. Crea el archivo .mcp.json en la raíz de tu proyecto, si no existe.
  3. Agrega la configuración, reemplaza las variables de entorno por tus valores y guarda los cambios:
      {
        "mcpServers": {
          "dataplex": {
            "command": "./PATH/TO/toolbox",
            "args": ["--prebuilt","dataplex","--stdio"],
            "env": {
              "DATAPLEX_PROJECT": "PROJECT_ID"
            }
          }
        }
      }
      

Claude para computadoras de escritorio

  1. Abre Claude Desktop y navega a Configuración.
  2. Para abrir el archivo de configuración, en la pestaña Desarrollador, haz clic en Editar configuración.
  3. Agrega la configuración, reemplaza las variables de entorno por tus valores y guarda:
      {
        "mcpServers": {
          "dataplex": {
            "command": "./PATH/TO/toolbox",
            "args": ["--prebuilt","dataplex","--stdio"],
            "env": {
              "DATAPLEX_PROJECT": "PROJECT_ID"
            }
          }
        }
      }
      
  4. Reinicia Claude para computadoras.
    En la nueva pantalla de chat, se muestra un ícono de MCP con el nuevo servidor de MCP.

Cline

  1. En VS Code, abre la extensión Cline y, luego, haz clic en el ícono de servidores de MCP.
  2. Para abrir el archivo de configuración, presiona Configure MCP Servers.
  3. Agrega la siguiente configuración, reemplaza las variables de entorno por tus valores y guarda los cambios:
      {
        "mcpServers": {
          "dataplex": {
            "command": "./PATH/TO/toolbox",
            "args": ["--prebuilt","dataplex","--stdio"],
            "env": {
              "DATAPLEX_PROJECT": "PROJECT_ID"
            }
          }
        }
      }
      
    Aparece un estado activo verde después de que el servidor se conecta correctamente.

Cursor

  1. Crea el directorio .cursor en la raíz del proyecto si no existe.
  2. Crea el archivo .cursor/mcp.json si no existe y ábrelo.
  3. Agrega la siguiente configuración, reemplaza las variables de entorno por tus valores y guarda los cambios:
      {
        "mcpServers": {
          "dataplex": {
            "command": "./PATH/TO/toolbox",
            "args": ["--prebuilt","dataplex","--stdio"],
            "env": {
              "DATAPLEX_PROJECT": "PROJECT_ID"
            }
          }
        }
      }
      
  4. Abre Cursor y navega a Configuración>Configuración del cursor >MCP. Cuando el servidor se conecta, aparece un estado activo de color verde.

VS Code (Copilot)

  1. Abre VS Code y crea el directorio .vscode en la raíz de tu proyecto si no existe.
  2. Crea el archivo .vscode/mcp.json si no existe y ábrelo.
  3. Agrega la siguiente configuración, reemplaza las variables de entorno por tus valores y guarda los cambios:
      {
        "servers": {
          "dataplex": {
            "command": "./PATH/TO/toolbox",
            "args": ["--prebuilt","dataplex","--stdio"],
            "env": {
              "DATAPLEX_PROJECT": "PROJECT_ID"
            }
          }
        }
      }
      

Windsurf

  1. Abre Windsurf y navega al asistente de Cascade.
  2. Para abrir el archivo de configuración, haz clic en el ícono de MCP y, luego, en Configurar.
  3. Agrega la siguiente configuración, reemplaza las variables de entorno por tus valores y guarda los cambios:
      {
        "mcpServers": {
          "dataplex": {
            "command": "./PATH/TO/toolbox",
            "args": ["--prebuilt","dataplex","--stdio"],
            "env": {
              "DATAPLEX_PROJECT": "PROJECT_ID"
            }
          }
        }
      }
      

Usa las herramientas

Tu herramienta de IA ahora está conectada a Dataplex Universal Catalog. Intenta pedirle a tu asistente de IA que busque algunos recursos de datos, como conjuntos de datos de BigQuery, instancias de Cloud SQL y otros.

Las siguientes herramientas están disponibles para el LLM:

Opcional: Agrega instrucciones del sistema

Las instrucciones del sistema son una forma de proporcionar lineamientos específicos al LLM, lo que lo ayuda a comprender el contexto y responder con mayor precisión. Configura las instrucciones del sistema según la instrucción del sistema recomendada.

Por ejemplo, puedes agregar instrucciones para guiar al LLM sobre cómo usar las herramientas de Dataplex Universal Catalog:

  • Cuando se te pida que encuentres conjuntos de datos o tablas, usa la herramienta dataplex_search_entries.
  • Si se te solicita el esquema de la tabla o detalles de los metadatos, como las reglas de calidad de los datos o la propiedad, usa la herramienta dataplex_lookup_entry.
  • Cuando se te pregunte sobre las reglas o clasificaciones de gobernanza, comienza por usar dataplex_search_aspect_types para encontrar tipos de aspectos relevantes.

Para obtener más información sobre cómo configurar instrucciones, consulta Usa instrucciones para obtener ediciones de IA que sigan tu estilo de programación.

¿Qué sigue?