Usa Knowledge Catalog con MCP, Gemini y otros agentes

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

Para una experiencia de línea de comandos integrada, te recomendamos que uses la extensión Knowledge Catalog dedicada para Gemini CLI. La extensión incluye las habilidades subyacentes directamente, lo que simplifica la configuración.

También puedes conectar otros IDEs y herramientas para desarrolladores que admitan MCP con un MCP Toolbox para bases de datos local. Luego, puedes usar agentes de IA en tu IDE existente para descubrir recursos de datos en Knowledge 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 Gemini CLI y las extensiones

Gemini CLI 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 Knowledge Catalog, y otras bases de datos populares de código abierto.

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

¿Cómo funcionan las extensiones de Gemini CLI?

Las extensiones amplían las capacidades de Gemini CLI, lo que le permite conectarse a Google Cloud servicios 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 habilidades, comandos de barra y mensajes de instrucción. Son independientes de las extensiones del IDE, como Gemini Code Assist, que se integran con MCP Toolbox.

¿Qué herramientas de MCP proporciona Knowledge Catalog?

La extensión de Knowledge Catalog para Gemini CLI integra la IA en tus tareas de descubrimiento y administración de datos. Puedes interactuar con Knowledge Catalog usando instrucciones en lenguaje natural en tu terminal.

Para ver todas las habilidades disponibles, consulta las habilidades del Knowledge Catalog en GitHub.

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

Roles obligatorios

Para obtener los permisos que necesitas para conectarte a Knowledge Catalog 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 a Knowledge Catalog con MCP Toolbox o la extensión de Gemini CLI. Para ver los permisos exactos que son necesarios, expande la sección Permisos requeridos:

Permisos necesarios

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

  • Para habilitar las APIs, sigue estos pasos: serviceusage.services.enable
  • Para usar las habilidades de Knowledge Catalog, sigue estos pasos:
    • 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.

Habilitar la API de Dataplex

  1. En la consola de Google Cloud , ve a la página del selector de proyectos.

    Ir al selector de proyectos

  2. Selecciona o crea un proyecto de Google Cloud .

    Roles necesarios para seleccionar o crear un proyecto

    • Selecciona un proyecto: Para seleccionar un proyecto, no se requiere un rol de IAM específico. Puedes seleccionar cualquier proyecto en el que se te haya otorgado un rol.
    • Crear un proyecto: Para crear un proyecto, necesitas el rol de Creador de proyectos (roles/resourcemanager.projectCreator), que contiene el permiso resourcemanager.projects.create. Obtén más información para otorgar roles.

  3. Verifica que la facturación esté habilitada para tu proyecto de Google Cloud .

  4. Habilitar la API de Dataplex

    Roles necesarios para habilitar las APIs

    Para habilitar APIs, necesitas el permiso serviceusage.services.enable. Si creaste el proyecto, es probable que ya tengas este permiso a través del rol de propietario (roles/owner). De lo contrario, puedes obtener este permiso a través del rol de administrador de Service Usage (roles/serviceusage.serviceUsageAdmin). Obtén más información para otorgar roles.

    Habilitar la API

  5. Si usas una shell local, crea credenciales de autenticación locales para tu cuenta de usuario: 

    gcloud auth application-default login

    No es necesario que lo hagas si usas Cloud Shell.

    Si se devuelve un error de autenticación y usas un proveedor de identidad (IdP) externo, confirma que accediste a la gcloud CLI con tu identidad federada.

Instala MCP Toolbox

No es necesario que instales MCP Toolbox si solo planeas usar Gemini Code Assist o la extensión de Gemini CLI, 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 objeto binario. Selecciona el objeto binario que corresponda a tu sistema operativo y arquitectura de la CPU. Debes usar MCP Toolbox v0.31.0 o una versión posterior.

    Linux/amd64

    curl -O https://storage.googleapis.com/mcp-toolbox-for-databases/VERSION/linux/amd64/toolbox

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

    macOS (Darwin)/arm64

    curl -O https://storage.googleapis.com/mcp-toolbox-for-databases/VERSION/darwin/arm64/toolbox

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

    macOS (Darwin)/amd64

    curl -O https://storage.googleapis.com/mcp-toolbox-for-databases/VERSION/darwin/amd64/toolbox

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

    Windows/amd64

    curl -O https://storage.googleapis.com/mcp-toolbox-for-databases/VERSION/windows/amd64/toolbox

    Reemplaza VERSION por la versión de MCP Toolbox, por ejemplo, v0.31.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 Knowledge 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 Gemini Code Assist o de la extensión de Gemini CLI.

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 Knowledge 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 Gemini CLI

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

  1. Instala la CLI de Gemini.
  2. Instala la extensión de Knowledge Catalog para Gemini CLI desde el repositorio de GitHub: 
    gemini extensions install https://github.com/gemini-cli-extensions/knowledge-catalog
  3. Establece la variable de entorno para conectarte a tu proyecto de Knowledge Catalog: 
    export DATAPLEX_PROJECT="PROJECT_ID"
     Reemplaza lo siguiente:
    • PROJECT_ID: Es el ID del proyecto de Google Cloud .
  4. Inicia Gemini CLI en modo interactivo: 
    gemini

    La CLI carga automáticamente la extensión de Knowledge Catalog y sus habilidades, que puedes usar para interactuar con tu base de datos.

    En la CLI de Gemini, usa el comando /extensions para verificar que la extensión esté instalada.

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: 
    {
  "mcpServers": {
    "knowledgeCatalog": {
      "command": "./PATH/TO/toolbox",
      "args": ["--prebuilt","dataplex","--stdio"],
      "env": {
        "DATAPLEX_PROJECT": "PROJECT_ID"
      }
    }
  }
}

Claude Code

  1. Instala Claude Code.
  2. Establece la variable de entorno para conectarte a tu proyecto de Knowledge Catalog: 
    export DATAPLEX_PROJECT="PROJECT_ID"
     Reemplaza lo siguiente:
    • PROJECT_ID: Es el ID del proyecto de Google Cloud .
  3. Inicia el agente: 
    claude
  4. Instala el complemento: 
    /plugin install knowledge-catalog@claude-plugins-official

Codex

  1. Instala el mercado de Data Agent Kit: 
    codex plugin marketplace add GoogleCloudPlatform/data-agent-kit
  2. Instala el complemento de Knowledge Catalog: 
    codex plugin install dataplex@data-agent-kit
  3. Configura las variables de entorno para conectarte a tu proyecto de Knowledge Catalog: 
    export DATAPLEX_PROJECT="PROJECT_ID"
     Reemplaza lo siguiente:
    • PROJECT_ID: Es el ID del proyecto de Google Cloud .
  4. Es opcional. Actualiza el mercado: 
    codex plugin marketplace upgrade data-agent-kit

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": {
    "knowledgeCatalog": {
      "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 MCP Servers.
  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: 
    {
  "mcpServers": {
    "knowledgeCatalog": {
      "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": {
    "knowledgeCatalog": {
      "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 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: 
    {
  "servers": {
    "knowledgeCatalog": {
      "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": {
    "knowledgeCatalog": {
      "command": "./PATH/TO/toolbox",
      "args": ["--prebuilt","dataplex","--stdio"],
      "env": {
        "DATAPLEX_PROJECT": "PROJECT_ID"
      }
    }
  }
}

Cómo usar las habilidades

Tu asistente de IA ahora está conectado a Knowledge Catalog. Intenta pedirle a tu asistente de IA que encuentre algunos recursos de datos, como conjuntos de datos de BigQuery, instancias de Cloud SQL y otros.

Para ver todas las habilidades disponibles, consulta las habilidades del Knowledge Catalog en GitHub.

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 habilidades de Knowledge Catalog:

  • Cuando se te pida que encuentres conjuntos de datos o tablas, usa la habilidad 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 habilidad lookup_entry.
  • Cuando se te pregunte sobre reglas o clasificaciones de administración, comienza por usar search_aspect_types para encontrar tipos de aspectos relevantes.
  • Si responder preguntas requiere un amplio conjunto de metadatos, usa la habilidad lookup_context para recuperarlos.

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?