Skip to content

Configuração do servidor Braze MCP

Saiba como configurar o servidor Braze MCP para que você possa interagir com seus dados Braze por meio de linguagem natural usando ferramentas como Claude e Cursor. Para saber mais sobre informações gerais, consulte Braze MCP server.

Pré-requisitos

Antes de começar, você precisará do seguinte:

Configuração do servidor Braze MCP

Etapa 1: Instalar uv

Primeiro, instale o uv, uma ferramenta de linha de comando da Astral para gerenciamento de dependências e manipulação de pacotes Python.

Abra seu aplicativo de terminal, cole o seguinte comando e pressione Enter.

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

A saída é semelhante à seguinte:

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!

Abra o Windows PowerShell, cole o seguinte comando e pressione Enter.

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

A saída é semelhante à seguinte:

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!

Etapa 2: Criar uma chave de API

O servidor MCP da Braze suporta 38 pontos de extremidade somente leitura que não retornam dados de perfis de usuários da Braze. Acesse Settings > APIs and Identifiers > API Keys e crie uma nova chave com algumas ou todas as permissões a seguir.

List of read-only, non-PII permissions

Campanhas

Canva

Catálogos

Ingestão de dados na nuvem

Blocos de conteúdo

Atributos personalizados

Eventos

KPIs

Mensagens

Central de Preferências

Compras

Segmentos

Envios

Sessões

Chaves de autenticação do SDK

Inscrição

Modelos

Etapa 3: Obtenha seu identificador e ponto de extremidade

Ao configurar seu cliente MCP, você precisará do identificador da chave de API e do endpoint REST do seu espaço de trabalho. Para obter esses detalhes, volte à página Chaves de API no dashboard - mantenha essa página aberta para que você possa consultá-la na próxima etapa.

As "Chaves de API" no Braze mostram uma chave de API recém-criada e o endpoint REST do usuário.

Etapa 4: Configure seu cliente MCP

Configure seu cliente MCP usando o arquivo de configuração fornecido previamente.

Configure seu servidor MCP usando o diretório do conector do Claude Desktop.

  1. No Claude Desktop, acesse Configurações > Conectores > Procurar conectores > Extensões de desktop > Braze MCP Server > Instalar.
  2. Digite sua chave de API e o URL de base.
  3. Salve a configuração e reinicie o Claude Desktop.

No Cursor, acesse Configurações > Ferramentas e integrações > Ferramentas MCP > Adicionar MCP personalizado e, em seguida, adicione o seguinte snippet:

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"
      }
    }
  }
}

Substitua key-identifier e rest-endpoint pelos valores correspondentes da página Chaves de API no Braze. Sua configuração deve ser semelhante à seguinte:

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"
      }
    }
  }
}

Quando terminar, salve a configuração e reinicie o Cursor.

A CLI do Gemini lê as configurações do usuário em ~/.gemini/settings.json. Se ele não existir, você poderá criá-lo executando o seguinte no terminal:

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

Em seguida, substitua yourname pela string exata antes de @BZXXXXXXXX no prompt do terminal. Em seguida, substitua key-identifier e rest-endpoint pelos valores correspondentes da página de chaves de API no Braze.

Sua configuração deve ser semelhante à seguinte:

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"
      }
    }
  }
}

Quando terminar, salve a configuração e reinicie a CLI do Gemini. Em seguida, no Gemini, execute os seguintes comandos para verificar se o servidor Braze MCP está listado e se as ferramentas e o esquema estão disponíveis para uso:

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

Você deverá ver o servidor braze listado com as ferramentas e o esquema disponíveis para uso.

Etapa 5: Enviar um prompt de teste

Depois de configurar o servidor Braze MCP, tente enviar um prompt de teste para seu cliente MCP. Para obter outros exemplos e práticas recomendadas, consulte Usando o servidor Braze MCP.

"Quais são as minhas funções disponíveis no Braze?" sendo perguntado e respondido em Claude.

"Quais são minhas funções Braze disponíveis" sendo perguntadas e respondidas no Cursor.

Quais são as minhas funções Braze disponíveis? que estão sendo perguntadas e respondidas na CLI do Gemini.

Solução de problemas

Erros no terminal

uvx comando não encontrado

Se você receber um erro informando que o comando uvx não foi encontrado, reinstale o uv e reinicie o terminal.

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

spawn uvx ENOENT erro

Se você receber um erro spawn uvx ENOENT, talvez seja necessário atualizar o caminho do arquivo no arquivo de configuração do seu cliente. Primeiro, abra seu terminal e execute o seguinte comando:

1
which uvx

O comando deve retornar uma mensagem semelhante à seguinte:

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

Copie a mensagem para a área de transferência e abra o arquivo de configuração do seu cliente. Substitua "command": "uvx" pela jornada que você copiou e reinicie o cliente. Por exemplo:

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

Falha na instalação do pacote

Se a instalação do pacote falhar, tente instalar uma versão específica do Python.

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

Configuração do cliente

O cliente MCP não consegue encontrar o servidor Braze

  1. Verifique se a sintaxe da configuração do cliente MCP está correta.
  2. Reinicie o cliente MCP após as alterações de configuração.
  3. Verifique se uvx está em seu sistema PATH.

Erros de autenticação

  1. Verifique se o endereço BRAZE_API_KEY está correto e ativo.
  2. Verifique se o endereço BRAZE_BASE_URL corresponde à sua instância do Braze.
  3. Verifique se sua chave de API tem as permissões corretas.

Tempo limite de conexão ou erros de rede

  1. Verifique se o endereço BRAZE_BASE_URL está correto para sua instância.
  2. Verifique sua conexão de rede e as configurações de firewall.
  3. Verifique se você está usando HTTPS em seu URL de base.

O Modelo de Protocolo de Contexto (MCP) é um protocolo de código aberto recém-introduzido que pode ser suscetível a problemas de segurança ou vulnerabilidades neste momento.

O código e as instruções de configuração do servidor Braze MCP são fornecidos pela Braze “como estão” e sem garantias, e os clientes o utilizam por sua própria conta e risco. A Braze não será responsável por quaisquer consequências decorrentes de configuração inadequada, uso indevido do MCP ou quaisquer problemas de segurança potenciais que possam surgir. A Braze incentiva fortemente os clientes a revisar suas configurações cuidadosamente e a seguir as diretrizes descritas para reduzir os riscos associados à integridade e segurança de seu ambiente Braze.

Para assistência ou esclarecimentos, entre em contato com [email protected].

New Stuff!