Skip to content

Configuration du serveur Braze MCP

Découvrez comment configurer le serveur Braze MCP afin de pouvoir interagir avec vos données Braze en utilisant un langage naturel grâce à des outils tels que Claude et Cursor. Pour obtenir des informations générales, veuillez consulter le serveur Braze MCP

Conditions préalables

Avant de commencer, vous avez besoin des éléments suivants :

Configuration du serveur Braze MCP

Étape 1 : Veuillez installer uv

Tout d’abord, veuillez installer uv—un outil en ligne de commande développé par Astral pour la gestion des dépendances et la manipulation des paquets Python.

Veuillez ouvrir votre application de terminal, copier-coller la commande suivante, puis appuyer sur Entrée.

1
curl -LsSf https://astral.sh/uv/install.sh | sh

Le résultat est similaire à ce qui suit :

1
2
3
4
5
6
7
8
$ curl -LsSf https://astral.sh/uv/install.sh | sh

downloading uv 0.8.9 aarch64-apple-darwin
no checksums to verify
installing to /Users/Isaiah.Robinson/.local/bin
  uv
  uvx
everything's installed!

Veuillez ouvrir Windows PowerShell, insérer la commande suivante, puis appuyer sur Entrée.

1
irm https://astral.sh/uv/install.ps1 | iex

Le résultat est similaire à ce qui suit :

1
2
3
4
5
6
7
8
PS C:\Users\YourUser> irm https://astral.sh/uv/install.ps1 | iex

Downloading uv 0.8.9 (x86_64-pc-windows-msvc)
no checksums to verify
installing to C:\Users\YourUser\.local\bin
  uv.exe
  uvx.exe
everything's installed!

Étape 2 : Créer une clé API

Le serveur MCP Braze prend en charge 38 endpoints en lecture seule qui ne renvoient pas les données des profils utilisateurs Braze. Veuillez vous rendre dans Paramètres > API et identifiants > Clés API et créer une nouvelle clé avec certaines ou toutes les autorisations suivantes.

List of read-only, non-PII permissions

Campagnes

Canvas

Catalogues

Ingestion de données cloud

Blocs de contenu

Attributs personnalisés

Événements

Indicateurs clé de performance

Messages

Centre de préférences

Achats

Segments

Envois

Sessions

Clés d’authentification SDK

Abonnement

Modèles

Étape 3 : Obtenez votre identifiant et votre endpoint

Lorsque vous configurez votre client MCP, vous aurez besoin de l’identifiant de votre clé API et de l’endpoint REST de votre espace de travail. Pour obtenir ces informations, veuillez retourner à la page Clés API dans le tableau de bord. Veuillez garder cette page ouverte afin de pouvoir vous y référer lors de l’étape suivante.

Les « clés API » dans Braze affichent une clé API nouvellement créée et l'endpoint REST de l'utilisateur.

Étape 4 : Veuillez configurer votre client MCP.

Veuillez configurer votre client MCP à l’aide du fichier de configuration fourni.

Veuillez configurer votre serveur MCP en utilisant le répertoire du connecteur Claude Desktop.

  1. Dans Claude Desktop, veuillez vous rendre dans Paramètres > Connecteurs > Parcourir les connecteurs > Extensions de bureau > Serveur Braze MCP > Installer.
  2. Veuillez saisir votre clé API et votre URL de base.
  3. Veuillez enregistrer la configuration et redémarrer Claude Desktop.

Dans Cursor, veuillez vous rendre dans Paramètres > Outils et intégrations > Outils MCP > Ajouter un MCP personnalisé, puis ajoutez l’extrait de code suivant :

1
2
3
4
5
6
7
8
9
10
11
12
{
  "mcpServers": {
    "braze": {
      "command": "uvx",
      "args": ["--native-tls", "braze-mcp-server@latest"],
      "env": {
        "BRAZE_API_KEY": "your-braze-api-key",
        "BRAZE_BASE_URL": "your-braze-endpoint-url"
      }
    }
  }
}

Veuillez remplacerkey-identifier etrest-endpoint par les valeurs correspondantes figurant sur la page Clés API dans Braze. Votre configuration devrait être similaire à celle-ci :

1
2
3
4
5
6
7
8
9
10
11
12
{
  "mcpServers": {
    "braze": {
      "command": "uvx",
      "args": ["--native-tls", "braze-mcp-server@latest"],
      "env": {
        "BRAZE_API_KEY": "2e8b-3c6c-d12e-bd75-4f0e2a8e5c71",
        "BRAZE_BASE_URL": "https://torchie.braze.com"
      }
    }
  }
}

Une fois que vous avez terminé, veuillez enregistrer la configuration et redémarrer Cursor.

Gemini CLI lit les paramètres utilisateur à partir de ~/.gemini/settings.json. Si ce fichier n’existe pas, vous pouvez le créer en exécutant la commande suivante dans votre terminal :

1
2
mkdir -p ~/.gemini
nano ~/.gemini/settings.json

Ensuite, veuillez remplaceryournamepar la chaîne de caractères exacte précédant@BZXXXXXXXXdans votre invite de commande. Veuillez ensuite remplacerkey-identifieretrest-endpointpar les valeurs correspondantes figurant sur la page Clés API dans Braze.

Votre configuration devrait être similaire à celle-ci :

1
2
3
4
5
6
7
8
9
10
11
12
{
  "mcpServers": {
    "braze": {
      "command": "/Users/yourname/.local/bin/uvx",
      "args": ["--native-tls", "braze-mcp-server@latest"],
      "env": {
        "BRAZE_API_KEY": "2e8b-3c6c-d12e-bd75-4f0e2a8e5c71",
        "BRAZE_BASE_URL": "https://torchie.braze.com"
      }
    }
  }
}

Une fois que vous avez terminé, veuillez enregistrer la configuration et redémarrer Gemini CLI. Ensuite, dans Gemini, exécutez les commandes suivantes pour vérifier que le serveur Braze MCP est répertorié et que les outils et le schéma sont disponibles :

1
2
3
4
gemini
/mcp
/mcp desc
/mcp schema

Vous devriez voir lebrazeserveur répertorié avec les outils et le schéma disponibles à l’utilisation.

Étape 5 : Veuillez envoyer une invite de test.

Une fois le serveur Braze MCP configuré, veuillez essayer d’envoyer une invite de test à votre client MCP. Pour d’autres exemples et bonnes pratiques, veuillez consulter Utilisation du serveur Braze MCP.

« Quelles sont les fonctions Braze à ma disposition ? » : question posée et réponse fournie dans Claude.

« Quelles sont les fonctions Braze disponibles ? » : question posée et réponse fournie dans Cursor.

Quelles sont les fonctions Braze disponibles pour moi ? Cette question est posée et traitée dans Gemini CLI.

Résolution des problèmes

Erreurs de terminal

uvx commande introuvable

Si vous recevez une erreur indiquant queuvxla commande est introuvable, veuillez réinstalleruvet redémarrer votre terminal.

1
curl -LsSf https://astral.sh/uv/install.sh | sh

spawn uvx ENOENT erreur

Si vous rencontrez desspawn uvx ENOENTerreurs, il peut être nécessaire de mettre à jour le chemin d’accès au fichier dans le fichier de configuration de votre client. Tout d’abord, veuillez ouvrir votre terminal et exécuter la commande suivante :

1
which uvx

La commande devrait renvoyer un message similaire à celui-ci :

1
/Users/alex-lee/.local/bin/uvx

Veuillez copier le message dans votre presse-papiers et ouvrir le fichier de configuration de votre client. Veuillez remplacer"command": "uvx"par le chemin d’accès que vous avez copié, puis redémarrez votre client. Par exemple :

1
"command": "/Users/alex-lee/.local/bin/uvx"

L’installation du paquet échoue

Si l’installation de votre paquet échoue, veuillez essayer d’installer une version spécifique de Python à la place.

1
uvx --python 3.12 braze-mcp-server@latest

Configuration client

Le client MCP ne parvient pas à localiser le serveur Braze.

  1. Veuillez vérifier que la syntaxe de configuration de votre client MCP est correcte.
  2. Veuillez redémarrer votre client MCP après avoir modifié la configuration.
  3. Veuillez vérifier que [nom du fichieruvx] est présent dans votre systèmePATH.

Erreurs d’authentification

  1. Veuillez vérifier que votreBRAZE_API_KEY est correct et actif.
  2. Veuillez vous assurer que votre configurationBRAZE_BASE_URLcorrespond à votre instance Braze.
  3. Veuillez vérifier que votre clé API dispose des autorisations appropriées.

Délais d’attente de connexion ou erreurs réseau

  1. Veuillez vérifier que votreBRAZE_BASE_URL est correct pour votre instance.
  2. Veuillez vérifier votre connexion réseau et les paramètres de votre pare-feu.
  3. Veuillez vous assurer que vous utilisez le protocole HTTPS dans votre URL de base.

Clause de non-responsabilité

Le protocole MCP (Model Context Protocol) est un protocole open source récemment introduit qui pourrait présenter des problèmes de sécurité ou des vulnérabilités à l’heure actuelle.

Le code et les instructions de configuration du serveur Braze MCP sont fournis par Braze « tels quels » et sans aucune garantie. Les clients les utilisent à leurs propres risques. Braze ne saurait être tenu responsable des conséquences résultant d’une configuration incorrecte, d’une mauvaise utilisation du MCP ou de tout problème de sécurité potentiel pouvant survenir. Braze recommande vivement à ses clients de vérifier attentivement leurs configurations et de suivre les directives fournies afin de réduire les risques liés à l’intégrité et à la sécurité de leur environnement Braze.

Pour toute assistance ou clarification, veuillez contacter [email protected].

New Stuff!