Utiliser Dataplex Universal Catalog avec MCP, Gemini et d'autres agents

Cette page explique comment connecter votre instance Dataplex Universal Catalog à des outils pour les développeurs tels que l'interface de ligne de commande Gemini. En connectant Dataplex Universal Catalog à ces outils, vous pouvez découvrir des données et gérer des composants grâce à l'IA directement dans votre IDE.

Pour une expérience en ligne de commande intégrée, nous vous recommandons d'utiliser l'extension Dataplex Universal Catalog dédiée pour Gemini CLI. L'extension regroupe le serveur MCP (Model Context Protocol) sous-jacent, qui sert d'intermédiaire entre la CLI Gemini et Dataplex Universal Catalog, ce qui élimine la nécessité de configurer un serveur distinct.

Vous pouvez également connecter d'autres IDE et outils pour les développeurs compatibles avec MCP à l'aide de la MCP Toolbox for Databases à usage général. Vous pouvez ensuite utiliser des agents d'IA dans votre IDE existant pour découvrir des éléments de données dans Dataplex Universal Catalog. Pour en savoir plus sur le protocole MCP, consultez Présentation du protocole MCP (Model Context Protocol).

Ce guide explique comment connecter les outils suivants :

À propos de la CLI Gemini et des extensions

La CLI Gemini est un agent d'IA conversationnelle Open Source de Google qui accélère les workflows de développement et aide à la programmation, au débogage, à l'exploration de données et à la création de contenu. Il offre une expérience basée sur des agents pour interagir avec les services Data Cloud, tels que Dataplex Universal Catalog, et d'autres bases de données Open Source populaires.

Pour en savoir plus sur la CLI Gemini, consultez la documentation sur la CLI Gemini.

Fonctionnement des extensions

Les extensions étendent les capacités de Gemini CLI, lui permettant de se connecter à des services Google Cloud spécifiques et à d'autres outils, et de les contrôler. Ils fournissent à Gemini le contexte et la compréhension de l'API, ce qui permet une interaction conversationnelle. Vous pouvez charger les extensions Gemini CLI à partir d'URL GitHub, de répertoires locaux ou de registres. Ces extensions offrent de nouveaux outils, commandes à barre oblique et requêtes. Elles sont distinctes des extensions d'IDE, telles que Gemini Code Assist, qui s'intègrent à l'aide de la boîte à outils MCP.

À propos de l'extension Dataplex Universal Catalog

MCP Toolbox for Databases est en version bêta (pré-v1.0) et peut subir des modifications destructives jusqu'à la première version stable (v1.0).

L'extension Dataplex Universal Catalog pour Gemini CLI intègre l'IA à vos tâches de gouvernance et de découverte des données. Vous pouvez interagir avec Dataplex Universal Catalog à l'aide de requêtes en langage naturel dans votre terminal. Voici quelques exemples :

Catégorie Outil Exemple de requête en langage naturel
Découverte et gouvernance des données dataplex_search_entries
  • Trouvez tous les ensembles de données liés aux ventes en Europe.
  • Affiche-moi les tables qui contiennent des informations client permettant d'identifier personnellement les utilisateurs.
  • Lister tous les ensembles de données BigQuery du lac "marketing" dans Dataplex Universal Catalog.
dataplex_lookup_entry
  • Quel est le schéma de la table "orders" ?
  • Décrivez les règles de qualité des données appliquées à la base de données client.
  • Qui est indiqué comme propriétaire de l'entreprise pour la table "customer_details" ?
dataplex_search_aspect_types
  • Affiche-moi les types d'aspects liés aux règles de qualité des données.
  • Liste tous les types d'aspects utilisés pour la gouvernance des données.
  • Existe-t-il des types d'aspects permettant de marquer les données à caractère personnel ?

Pour en savoir plus sur l'extension Dataplex Universal Catalog, consultez Extension Gemini CLI – Dataplex Universal Catalog.

Rôles et autorisations requis

Pour obtenir les autorisations nécessaires pour vous connecter à Dataplex Universal Catalog à l'aide de MCP Toolbox ou de l'extension Gemini CLI, demandez à votre administrateur de vous accorder les rôles IAM suivants sur votre projet :

Pour en savoir plus sur l'attribution de rôles, consultez Gérer l'accès aux projets, aux dossiers et aux organisations.

Ces rôles prédéfinis contiennent les autorisations requises pour se connecter au catalogue universel Dataplex à l'aide de MCP Toolbox ou de l'extension Gemini CLI. Pour connaître les autorisations exactes requises, développez la section Autorisations requises :

Autorisations requises

Les autorisations suivantes sont requises pour se connecter à Dataplex Universal Catalog à l'aide de MCP Toolbox ou de l'extension Gemini CLI :

  • Pour activer les API : serviceusage.services.enable
  • Pour utiliser les outils Dataplex Universal Catalog :
    • dataplex.projects.search
    • dataplex.entries.get
    • dataplex.aspectTypes.get
    • dataplex.aspectTypes.list

Vous pouvez également obtenir ces autorisations avec des rôles personnalisés ou d'autres rôles prédéfinis.

Activer l'API Dataplex Universal Catalog

  1. Consultez les autorisations requises pour effectuer les tâches décrites dans ce guide.

  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.

Installer la boîte à outils MCP

Vous n'avez pas besoin d'installer MCP Toolbox si vous prévoyez uniquement d'utiliser Gemini Code Assist ou l'extension CLI Gemini, car elles incluent les fonctionnalités de serveur requises. Pour les autres IDE et outils, suivez les étapes de cette section pour installer MCP Toolbox.

  1. Téléchargez la dernière version de MCP Toolbox en tant que binaire. Sélectionnez le fichier binaire qui correspond à votre système d'exploitation et à votre architecture de processeur. Vous devez utiliser MCP Toolbox v0.15.0 ou version ultérieure.

    Linux/amd64

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

    Remplacez VERSION par la version de MCP Toolbox, par exemple v0.15.0.

    macOS (Darwin)/arm64

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

    Remplacez VERSION par la version de MCP Toolbox, par exemple v0.15.0.

    macOS (Darwin)/amd64

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

    Remplacez VERSION par la version de MCP Toolbox, par exemple v0.15.0.

    Windows/amd64

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

    Remplacez VERSION par la version de MCP Toolbox, par exemple v0.15.0.

  2. Rendez le binaire exécutable :

    chmod +x toolbox

  3. Vérifiez l'installation :

    ./toolbox --version

    Si l'installation aboutit, le numéro de version s'affiche (par exemple, 0.15.0).

Configurer les clients et les connexions

Cette section explique comment connecter Dataplex Universal Catalog à vos outils.

Si vous utilisez Gemini Code Assist ou l'interface de ligne de commande Gemini autonome, vous n'avez pas besoin d'installer ni de configurer MCP Toolbox, car ces outils regroupent les fonctionnalités de serveur requises. Pour obtenir des instructions de configuration, consultez les onglets "Extension Gemini Code Assist" ou "CLI Gemini".

Pour les autres outils et IDE compatibles avec MCP, vous devez d'abord installer MCP Toolbox. Cette boîte à outils agit comme un serveur MCP (Model Context Protocol) Open Source qui se situe entre votre IDE et Dataplex Universal Catalog. Elle fournit un plan de contrôle sécurisé et efficace pour vos outils d'IA. Après l'installation, sélectionnez l'onglet correspondant à votre outil pour afficher les instructions de configuration.

Extension Gemini CLI

Cette méthode utilise l'extension dataplex dédiée à l'outil CLI Gemini autonome et n'utilise pas MCP Toolbox.

  1. Installez la CLI Gemini.
  2. Installez l'extension Dataplex Universal Catalog pour la CLI Gemini à partir du dépôt GitHub : 
    gemini extensions install https://github.com/gemini-cli-extensions/dataplex
  3. Définissez la variable d'environnement pour vous connecter à votre projet Dataplex Universal Catalog : 
    export DATAPLEX_PROJECT="PROJECT_ID"

    Remplacez PROJECT_ID par l'ID du projet Google Cloud .

  4. Démarrez la CLI Gemini en mode interactif : 
    gemini
     La CLI charge automatiquement l'extension Dataplex Universal Catalog et ses outils, que vous pouvez utiliser pour interagir avec vos composants de données.

Gemini Code Assist

Gemini Code Assist regroupe les fonctionnalités de serveur MCP requises. Vous n'avez donc pas besoin d'installer MCP Toolbox séparément.

  1. Dans VS Code, installez l'extension Gemini Code Assist.
  2. Activez le mode Agent dans le chat Gemini Code Assist.
  3. Dans votre répertoire de travail, créez un dossier nommé .gemini. Dans ce dossier, créez un fichier settings.json.
  4. Ajoutez la configuration suivante, remplacez les variables d'environnement par vos valeurs et enregistrez : 
      {
    "mcpServers": {
      "dataplex": {
        "command": "./PATH/TO/toolbox",
        "args": ["--prebuilt","dataplex","--stdio"],
        "env": {
          "DATAPLEX_PROJECT": "PROJECT_ID"
        }
      }
    }
  }

Code Claude

  1. Installez Claude Code.
  2. Créez le fichier .mcp.json à la racine de votre projet, s'il n'existe pas.
  3. Ajoutez la configuration, remplacez les variables d'environnement par vos valeurs, puis enregistrez : 
      {
    "mcpServers": {
      "dataplex": {
        "command": "./PATH/TO/toolbox",
        "args": ["--prebuilt","dataplex","--stdio"],
        "env": {
          "DATAPLEX_PROJECT": "PROJECT_ID"
        }
      }
    }
  }

Claude sur ordinateur

  1. Ouvrez Claude Desktop et accédez à Settings (Paramètres).
  2. Pour ouvrir le fichier de configuration, dans l'onglet Développeur, cliquez sur Modifier la configuration.
  3. Ajoutez la configuration, remplacez les variables d'environnement par vos valeurs et enregistrez : 
      {
    "mcpServers": {
      "dataplex": {
        "command": "./PATH/TO/toolbox",
        "args": ["--prebuilt","dataplex","--stdio"],
        "env": {
          "DATAPLEX_PROJECT": "PROJECT_ID"
        }
      }
    }
  }
  4. Redémarrez Claude pour ordinateur.
    Le nouvel écran de chat affiche une icône MCP avec le nouveau serveur MCP.

Cline

  1. Dans VS Code, ouvrez l'extension Cline, puis cliquez sur l'icône Serveurs MCP.
  2. Pour ouvrir le fichier de configuration, appuyez sur Configurer les serveurs MCP.
  3. Ajoutez la configuration suivante, remplacez les variables d'environnement par vos valeurs et enregistrez : 
      {
    "mcpServers": {
      "dataplex": {
        "command": "./PATH/TO/toolbox",
        "args": ["--prebuilt","dataplex","--stdio"],
        "env": {
          "DATAPLEX_PROJECT": "PROJECT_ID"
        }
      }
    }
  }
    Un état actif vert s'affiche une fois le serveur connecté.

Cursor

  1. Créez le répertoire .cursor dans la racine de votre projet s'il n'existe pas.
  2. Créez le fichier .cursor/mcp.json s'il n'existe pas et ouvrez-le.
  3. Ajoutez la configuration suivante, remplacez les variables d'environnement par vos valeurs et enregistrez : 
      {
    "mcpServers": {
      "dataplex": {
        "command": "./PATH/TO/toolbox",
        "args": ["--prebuilt","dataplex","--stdio"],
        "env": {
          "DATAPLEX_PROJECT": "PROJECT_ID"
        }
      }
    }
  }
  4. Ouvrez Curseur, puis accédez à Paramètres>Paramètres du curseur >MCP. Un état actif vert s'affiche lorsque le serveur se connecte.

VS Code (Copilot)

  1. Ouvrez VS Code et créez le répertoire .vscode à la racine de votre projet s'il n'existe pas.
  2. Créez le fichier .vscode/mcp.json s'il n'existe pas, puis ouvrez-le.
  3. Ajoutez la configuration suivante, remplacez les variables d'environnement par vos valeurs et enregistrez : 
      {
    "servers": {
      "dataplex": {
        "command": "./PATH/TO/toolbox",
        "args": ["--prebuilt","dataplex","--stdio"],
        "env": {
          "DATAPLEX_PROJECT": "PROJECT_ID"
        }
      }
    }
  }

Windsurf

  1. Ouvrez Windsurf et accédez à l'assistant Cascade.
  2. Pour ouvrir le fichier de configuration, cliquez sur l'icône MCP, puis sur Configurer.
  3. Ajoutez la configuration suivante, remplacez les variables d'environnement par vos valeurs et enregistrez : 
      {
    "mcpServers": {
      "dataplex": {
        "command": "./PATH/TO/toolbox",
        "args": ["--prebuilt","dataplex","--stdio"],
        "env": {
          "DATAPLEX_PROJECT": "PROJECT_ID"
        }
      }
    }
  }

Utiliser les outils

Votre outil d'IA est désormais connecté à Dataplex Universal Catalog. Essayez de demander à votre assistant IA de trouver des composants de données tels que des ensembles de données BigQuery, des instances Cloud SQL et d'autres.

Les outils suivants sont à la disposition du LLM :

Facultatif : Ajoutez des instructions système.

Les instructions système permettent de fournir des consignes spécifiques au LLM, ce qui l'aide à comprendre le contexte et à répondre plus précisément. Configurez les instructions système en fonction de la requête système recommandée.

Par exemple, vous pouvez ajouter des instructions pour guider le LLM sur l'utilisation des outils Dataplex Universal Catalog :

  • Lorsque vous êtes invité à trouver des ensembles de données ou des tables, utilisez l'outil dataplex_search_entries.
  • Si vous êtes invité à fournir des informations sur le schéma ou les métadonnées d'une table, comme les règles de qualité des données ou la propriété, utilisez l'outil dataplex_lookup_entry.
  • Lorsque vous êtes interrogé sur des règles de gouvernance ou des classifications, commencez par utiliser dataplex_search_aspect_types pour trouver les types d'aspects pertinents.

Pour savoir comment configurer les instructions, consultez Utiliser des instructions pour obtenir des modifications de l'IA qui respectent votre style de programmation.

Étapes suivantes