Connecter votre IDE à AlloyDB à l'aide de MCP Toolbox

Cette page vous explique comment utiliser la MCP Toolbox for Databases pour connecter votre instance AlloyDB pour PostgreSQL à des environnements de développement intégrés (IDE) et à des outils de développement compatibles avec le Model Context Protocol (MCP). Utilisez ces outils pour exécuter des requêtes SQL et interagir avec votre base de données. Ce guide s'adresse aux développeurs qui utilisent leurs IDE et outils pour les développeurs existants pour travailler avec AlloyDB.

Cette page suppose que vous disposez d'une base de données AlloyDB et que votre instance AlloyDB possède une adresse IP publique. Pour en savoir plus, consultez Créer une base de données AlloyDB avec la boîte à outils MCP.

Le Model Context Protocol (MCP) est un protocole ouvert permettant de connecter des grands modèles de langage (LLM) à des sources de données telles qu'AlloyDB. Cette page explique comment utiliser MCP Toolbox for Databases pour exposer vos outils d'assistance aux développeurs à une instance AlloyDB à l'aide de l'IDE suivant :

Avant de commencer

Assurez-vous de disposer des rôles requis.

Rôles requis

Pour vous connecter à l'instance AlloyDB, vous avez besoin des rôles ou des autorisations IAM (Identity and Access Management) équivalentes suivants :

  • Client Cloud AlloyDB (roles/alloydb.client)
  • Consommateur Service Usage (roles/serviceusage.serviceUsageConsumer)

Configurer la base de données

  1. Sign in to your Google Cloud account. If you're new to Google Cloud, create an account to evaluate how our products perform in real-world scenarios. New customers also get $300 in free credits to run, test, and deploy workloads.
  2. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  3. Verify that billing is enabled for your Google Cloud project.

  4. In the Google Cloud console, on the project selector page, select or create a Google Cloud project.

    Go to project selector

  5. Verify that billing is enabled for your Google Cloud project.

  6. Activez les APIs Cloud nécessaires pour créer et vous connecter à AlloyDB pour PostgreSQL.

    Activer les API

    1. À l'étape Confirmer le projet, cliquez sur Suivant pour confirmer le nom du projet que vous allez modifier.

    2. À l'étape Activer les API, cliquez sur Activer pour activer les éléments suivants :

      • API AlloyDB
      • API Compute Engine
      • API Cloud Resource Manager
      • API Service Networking

      L'API Service Networking est requise si vous prévoyez de configurer la connectivité réseau à AlloyDB à l'aide d'un réseau VPC qui réside dans le même projet Google Cloud qu'AlloyDB.

      Les API Compute Engine et Cloud Resource Manager sont requises si vous prévoyez de configurer la connectivité réseau à AlloyDB à l'aide d'un réseau VPC résidant dans un autre projet Google Cloud .

  7. Créez ou sélectionnez un cluster et son instance principale. MCP Toolbox se connecte de manière sécurisée à votre instance à l'aide des connecteurs de langage AlloyDB.
  8. Configurez les identifiants par défaut de l'application pour votre environnement.
  9. Créez ou réutilisez un utilisateur de base de données. Préparez-vous à saisir le nom d'utilisateur et le mot de passe.
  10. Installer la boîte à outils MCP

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

      linux/amd64

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

      darwin/arm64

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

      darwin/amd64

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

      windows/amd64

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

    2. Rendez le binaire exécutable.

      chmod +x toolbox
      
    3. Vérifiez l'installation.

      ./toolbox --version
      

    Configurer le client MCP

    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": {
        "alloydb": {
          "command": "./PATH/TO/toolbox",
          "args": ["--prebuilt","alloydb-postgres","--stdio"],
          "env": {
              "ALLOYDB_POSTGRES_PROJECT": "PROJECT_ID",
              "ALLOYDB_POSTGRES_REGION": "REGION",
              "ALLOYDB_POSTGRES_CLUSTER": "CLUSTER_NAME",
              "ALLOYDB_POSTGRES_INSTANCE": "INSTANCE_NAME",
              "ALLOYDB_POSTGRES_DATABASE": "DATABASE_NAME",
              "ALLOYDB_POSTGRES_USER": "USERNAME",
              "ALLOYDB_POSTGRES_PASSWORD": "PASSWORD"
          }
        }
      }
    }
    

    Claude sur ordinateur

    1. Ouvrez Claude Desktop et accédez à Settings (Paramètres).
    2. Dans l'onglet Développeur, cliquez sur Modifier la configuration pour ouvrir le fichier de configuration.
    3. Ajoutez la configuration, remplacez les variables d'environnement par vos valeurs, puis enregistrez.

    {
      "mcpServers": {
        "alloydb": {
          "command": "./PATH/TO/toolbox",
          "args": ["--prebuilt","alloydb-postgres","--stdio"],
          "env": {
              "ALLOYDB_POSTGRES_PROJECT": "PROJECT_ID",
              "ALLOYDB_POSTGRES_REGION": "REGION",
              "ALLOYDB_POSTGRES_CLUSTER": "CLUSTER_NAME",
              "ALLOYDB_POSTGRES_INSTANCE": "INSTANCE_NAME",
              "ALLOYDB_POSTGRES_DATABASE": "DATABASE_NAME",
              "ALLOYDB_POSTGRES_USER": "USERNAME",
              "ALLOYDB_POSTGRES_PASSWORD": "PASSWORD"
          }
        }
      }
    }
    
    1. Redémarrez Claude Desktop.
    2. Le nouvel écran de chat affiche une icône en forme de marteau (MCP) avec le nouveau serveur MCP.

    Cline

    1. Ouvrez l'extension Cline dans VS Code, puis appuyez sur l'icône Serveurs MCP.
    2. Cliquez sur Configurer les serveurs MCP pour ouvrir le fichier de configuration.
    3. Ajoutez la configuration suivante, remplacez les variables d'environnement par vos valeurs, puis enregistrez.

    {
      "mcpServers": {
        "alloydb": {
         "command": "./PATH/TO/toolbox",
          "args": ["--prebuilt","alloydb-postgres","--stdio"],
          "env": {
              "ALLOYDB_POSTGRES_PROJECT": "PROJECT_ID",
              "ALLOYDB_POSTGRES_REGION": "REGION",
              "ALLOYDB_POSTGRES_CLUSTER": "CLUSTER_NAME",
              "ALLOYDB_POSTGRES_INSTANCE": "INSTANCE_NAME",
              "ALLOYDB_POSTGRES_DATABASE": "DATABASE_NAME",
              "ALLOYDB_POSTGRES_USER": "USERNAME",
              "ALLOYDB_POSTGRES_PASSWORD": "PASSWORD"
          }
        }
      }
    }
    

    Un état actif vert s'affiche une fois que le serveur est 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, puis ouvrez-le.
    3. Ajoutez la configuration suivante, remplacez les variables d'environnement par vos valeurs, puis enregistrez.
    {
      "mcpServers": {
        "alloydb": {
          "command": "./PATH/TO/toolbox",
          "args": ["--prebuilt","alloydb-postgres","--stdio"],
          "env": {
              "ALLOYDB_POSTGRES_PROJECT": "PROJECT_ID",
              "ALLOYDB_POSTGRES_REGION": "REGION",
              "ALLOYDB_POSTGRES_CLUSTER": "CLUSTER_NAME",
              "ALLOYDB_POSTGRES_INSTANCE": "INSTANCE_NAME",
              "ALLOYDB_POSTGRES_DATABASE": "DATABASE_NAME",
              "ALLOYDB_POSTGRES_USER": "USERNAME",
              "ALLOYDB_POSTGRES_PASSWORD": "PASSWORD"
          }
        }
      } 
    }
    
    1. Ouvrez Cursor, puis accédez à Settings > Cursor Settings > MCP (Paramètres > Paramètres du curseur > MCP). Un état actif vert s'affiche lorsque le serveur se connecte.

    Visual Studio 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, puis enregistrez.
    {
      "servers": {
        "alloydb": {
          "command": "./PATH/TO/toolbox",
          "args": ["--prebuilt","alloydb-postgres","--stdio"],
          "env": {
            "ALLOYDB_POSTGRES_PROJECT": "PROJECT_ID",
            "ALLOYDB_POSTGRES_REGION": "REGION",
            "ALLOYDB_POSTGRES_CLUSTER": "CLUSTER_NAME",
            "ALLOYDB_POSTGRES_INSTANCE": "INSTANCE_NAME",
            "ALLOYDB_POSTGRES_DATABASE": "DATABASE_NAME",
            "ALLOYDB_POSTGRES_USER": "USERNAME",
            "ALLOYDB_POSTGRES_PASSWORD": "PASSWORD"
          }
        }
      }
    }
    

    Windsurf

    1. Ouvrez Windsurf et accédez à l'assistant Cascade.
    2. Cliquez sur l'icône MCP, puis sur Configurer pour ouvrir le fichier de configuration.
    3. Ajoutez la configuration suivante, remplacez les variables d'environnement par vos valeurs, puis enregistrez.
    {
      "mcpServers": {
        "alloydb": {
          "command": "./PATH/TO/toolbox",
          "args": ["--prebuilt","alloydb-postgres","--stdio"],
          "env": {
              "ALLOYDB_POSTGRES_PROJECT": "PROJECT_ID",
              "ALLOYDB_POSTGRES_REGION": "REGION",
              "ALLOYDB_POSTGRES_CLUSTER": "CLUSTER_NAME",
              "ALLOYDB_POSTGRES_INSTANCE": "INSTANCE_NAME",
              "ALLOYDB_POSTGRES_DATABASE": "DATABASE_NAME",
              "ALLOYDB_POSTGRES_USER": "USERNAME",
              "ALLOYDB_POSTGRES_PASSWORD": "PASSWORD"
          }
        }
      }
    }
    

    CLI Gemini

    1. Installez la CLI Gemini.
    2. Dans votre répertoire de travail, créez un dossier nommé .gemini. Dans ce dossier, créez un fichier settings.json.
    3. Ajoutez la configuration suivante, remplacez les variables d'environnement par vos valeurs, puis enregistrez.
    {
      "mcpServers": {
        "alloydb": {
          "command": "./PATH/TO/toolbox",
          "args": ["--prebuilt","alloydb-postgres","--stdio"],
          "env": {
              "ALLOYDB_POSTGRES_PROJECT": "PROJECT_ID",
              "ALLOYDB_POSTGRES_REGION": "REGION",
              "ALLOYDB_POSTGRES_CLUSTER": "CLUSTER_NAME",
              "ALLOYDB_POSTGRES_INSTANCE": "INSTANCE_NAME",
              "ALLOYDB_POSTGRES_DATABASE": "DATABASE_NAME",
              "ALLOYDB_POSTGRES_USER": "USERNAME",
              "ALLOYDB_POSTGRES_PASSWORD": "PASSWORD"
          }
        }
      }
    }
    

    Gemini Code Assist

    1. Installez l'extension Gemini Code Assist dans Visual Studio Code.
    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, puis enregistrez.
    {
      "mcpServers": {
        "alloydb": {
          "command": "./PATH/TO/toolbox",
          "args": ["--prebuilt","alloydb-postgres","--stdio"],
          "env": {
              "ALLOYDB_POSTGRES_PROJECT": "PROJECT_ID",
              "ALLOYDB_POSTGRES_REGION": "REGION",
              "ALLOYDB_POSTGRES_CLUSTER": "CLUSTER_NAME",
              "ALLOYDB_POSTGRES_INSTANCE": "INSTANCE_NAME",
              "ALLOYDB_POSTGRES_DATABASE": "DATABASE_NAME",
              "ALLOYDB_POSTGRES_USER": "USERNAME",
              "ALLOYDB_POSTGRES_PASSWORD": "PASSWORD"
          }
        }
      }
    }
    

    Utiliser les outils d'IA

    Votre outil d'IA est désormais connecté à AlloyDB à l'aide de MCP. Essayez de demander à votre assistant IA de lister des tables, d'en créer une ou de définir et d'exécuter d'autres instructions SQL.

    Les outils suivants sont à la disposition du LLM :

    • list_tables : liste les tables et les descriptions.
    • execute_sql : exécute n'importe quelle instruction SQL.