Skip to content

Configurer le serveur Braze MCP

Découvrez comment configurer le serveur Braze MCP afin de pouvoir interagir avec vos données Braze en langage naturel à l’aide d’outils tels que Claude et Cursor. Pour obtenir des informations plus générales, consultez Serveur Braze MCP.

Conditions préalables

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

Prérequis Description
Clé API Braze Une clé API Braze avec les autorisations requises. Vous créerez une nouvelle clé lors de la configuration de votre serveur Braze MCP.
Client MCP Claude, Cursor et Google Gemini CLI sont officiellement pris en charge. Vous devez disposer d’un compte auprès de l’un de ces clients pour utiliser le serveur Braze MCP.
Terminal Une application de terminal vous permettant d’exécuter des commandes et d’installer des outils. Utilisez votre application de terminal préférée ou celle préinstallée sur votre ordinateur.

Configuration du serveur Braze MCP

Étape 1 : Installer uv

Commencez par installer uv—un outil en ligne de commande développé par Astral pour la gestion des dépendances et des paquets Python.

Ouvrez votre application de terminal, collez la commande suivante, puis appuyez 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!

Ouvrez Windows PowerShell, collez la commande suivante, puis appuyez 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 Braze MCP comprend des endpoints en lecture seule et des endpoints en écriture. Ils ne renvoient pas de données issues des profils utilisateurs Braze. Les endpoints en écriture permettent aux agents de créer ou de mettre à jour du contenu dans votre espace de travail.

Pour créer votre clé API :

  1. Rendez-vous dans Settings > APIs and Identifiers > API Keys.
  2. Créez une nouvelle clé.
  3. Attribuez certaines ou toutes les autorisations suivantes à votre clé.
Liste des autorisations prises en charge

Campaigns

Endpoint Autorisation requise
/campaigns/data_series campaigns.data_series
/campaigns/details campaigns.details
/campaigns/list campaigns.list
/sends/data_series sends.data_series

Canvas

Endpoint Autorisation requise
/canvas/data_series canvas.data_series
/canvas/data_summary canvas.data_summary
/canvas/details canvas.details
/canvas/list canvas.list

Catalogs

Endpoint Autorisation requise
/catalogs catalogs.get
/catalogs/{catalog_name}/items catalogs.get_items
/catalogs/{catalog_name}/items/{item_id} catalogs.get_item

Cloud Data Ingestion

Endpoint Autorisation requise
/cdi/integrations cdi.integration_list
/cdi/integrations/{integration_id}/job_sync_status cdi.integration_job_status

Content Blocks

Les autorisations content_blocks.create et content_blocks.update sont des autorisations d’écriture. Ne les ajoutez que si vous souhaitez que votre agent puisse créer ou mettre à jour des Content Blocks dans votre espace de travail.

Endpoint Autorisation requise
/content_blocks/list content_blocks.list
/content_blocks/info content_blocks.info
/content_blocks/create content_blocks.create
/content_blocks/update content_blocks.update

Custom Attributes

Endpoint Autorisation requise
/custom_attributes custom_attributes.get

Events

Endpoint Autorisation requise
/events/list events.list
/events/data_series events.data_series
/events events.get

KPIs

Endpoint Autorisation requise
/kpi/new_users/data_series kpi.new_users.data_series
/kpi/dau/data_series kpi.dau.data_series
/kpi/mau/data_series kpi.mau.data_series
/kpi/uninstalls/data_series kpi.uninstalls.data_series

Media Library

L’autorisation media_library.create est une autorisation d’écriture. Ne l’ajoutez que si vous souhaitez que votre agent puisse importer des ressources dans votre bibliothèque multimédia.

Endpoint Autorisation requise
/media_library/create media_library.create

Messages

Endpoint Autorisation requise
/messages/scheduled_broadcasts messages.schedule_broadcasts

Preference Center

Endpoint Autorisation requise
/preference_center/v1/list preference_center.list
/preference_center/v1/{preferenceCenterExternalID} preference_center.get

Purchases

Endpoint Autorisation requise
/purchases/product_list purchases.product_list
/purchases/revenue_series purchases.revenue_series
/purchases/quantity_series purchases.quantity_series

Segments

Endpoint Autorisation requise
/segments/list segments.list
/segments/data_series segments.data_series
/segments/details segments.details

Sends

Endpoint Autorisation requise
/sends/data_series sends.data_series

Sessions

Endpoint Autorisation requise
/sessions/data_series sessions.data_series

SDK Authentication Keys

Endpoint Autorisation requise
/app_group/sdk_authentication/keys sdk_authentication.keys

Subscription

Endpoint Autorisation requise
/subscription/status/get subscription.status.get
/subscription/user/status subscription.groups.get

Templates

Les autorisations templates.email.create et templates.email.update sont des autorisations d’écriture. Ne les ajoutez que si vous souhaitez que votre agent puisse créer ou mettre à jour des modèles d’e-mail dans votre espace de travail.

Endpoint Autorisation requise
/templates/email/list templates.email.list
/templates/email/info templates.email.info
/templates/email/create templates.email.create
/templates/email/update templates.email.update

Étape 3 : Obtenir 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, retournez à la page API Keys dans le tableau de bord—gardez cette page ouverte afin de pouvoir vous y référer lors de l’étape suivante.

La page « API Keys » dans Braze affichant une clé API nouvellement créée et l'endpoint REST de l'utilisateur.

Étape 4 : Configurer votre client MCP

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

Configurez votre serveur MCP en utilisant le répertoire de connecteurs de Claude Desktop.

  1. Dans Claude Desktop, rendez-vous dans Settings > Connectors > Browse Connectors > Desktop Extensions > Braze MCP Server > Install.
  2. Saisissez votre clé API et votre URL de base.
  3. Enregistrez la configuration et redémarrez Claude Desktop.

Dans Cursor, rendez-vous dans Settings > Tools and Integrations > MCP Tools > Add Custom MCP, 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"
      }
    }
  }
}

Remplacez key-identifier et rest-endpoint par les valeurs correspondantes figurant sur la page API Keys dans Braze. Votre configuration devrait être similaire à ce qui suit :

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 terminé, enregistrez la configuration et redémarrez 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, remplacez yourname par la chaîne de caractères exacte précédant @BZXXXXXXXX dans votre invite de commande. Puis remplacez key-identifier et rest-endpoint par les valeurs correspondantes figurant sur la page API Keys dans Braze.

Votre configuration devrait être similaire à ce qui suit :

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 terminé, enregistrez la configuration et redémarrez 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 le serveur braze répertorié avec les outils et le schéma disponibles.

Étape 5 : Envoyer un prompt de test

Après avoir configuré le serveur Braze MCP, essayez d’envoyer un prompt de test à votre client MCP. Pour d’autres exemples et bonnes pratiques, consultez 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 ? » : question posée et réponse fournie dans Gemini CLI.

Résolution des problèmes

Erreurs de terminal

Commande uvx introuvable

Si vous recevez une erreur indiquant que la commande uvx est introuvable, réinstallez uv et redémarrez votre terminal.

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

Erreur spawn uvx ENOENT

Si vous rencontrez des erreurs spawn uvx ENOENT, il peut être nécessaire de mettre à jour le chemin d’accès dans le fichier de configuration de votre client. Commencez par ouvrir votre terminal et exécutez la commande suivante :

1
which uvx

La commande devrait renvoyer un message similaire à ce qui suit :

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

Copiez le message dans votre presse-papiers et ouvrez le fichier de configuration de votre client. Remplacez "command": "uvx" par le chemin 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, essayez d’installer une version spécifique de Python à la place.

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

Configuration du client

Le client MCP ne parvient pas à trouver le serveur Braze

  1. Vérifiez que la syntaxe de configuration de votre client MCP est correcte.
  2. Redémarrez votre client MCP après avoir modifié la configuration.
  3. Vérifiez que uvx est présent dans le PATH de votre système.

Erreurs d’authentification

  1. Vérifiez que votre BRAZE_API_KEY est correcte et active.
  2. Assurez-vous que votre BRAZE_BASE_URL correspond à votre instance Braze.
  3. Vérifiez que votre clé API dispose des autorisations appropriées.

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

  1. Vérifiez que votre BRAZE_BASE_URL est correcte pour votre instance.
  2. Vérifiez votre connexion réseau et les paramètres de votre pare-feu.
  3. Assurez-vous 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 MCP de Braze 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 l’Assistance Braze.

New Stuff!