Esta página foi traduzida automaticamente e pode conter imprecisões. Para relatar um erro de tradução, use o componente de feedback na parte inferior do sumário, à direita da página.
Funções do servidor Braze MCP
O servidor Braze MCP oferece ferramentas de leitura e escrita. A maioria delas corresponde a endpoints da REST API da Braze. Algumas estão disponíveis apenas pelo servidor MCP. Para saber mais, consulte servidor Braze MCP.

Importante
O servidor MCP da Braze hospedado localmente (beta) está descontinuado e não recebe atualizações adicionais.

Nota
O servidor Braze MCP inclui ferramentas disponíveis apenas para clientes que participam de programas beta, como as ferramentas do Operator. Se você tentar acessar uma ferramenta de um programa beta e sua conta não tiver o recurso ativado, poderá receber uma resposta de erro. Para participar de um programa beta, entre em contato com seu gerente de conta.
Pré-requisitos
Antes de usar este recurso, você precisará configurar o servidor Braze MCP.
Funções de API da Braze disponíveis
Seu cliente MCP usa estas ferramentas para interagir com o servidor Braze MCP. As ferramentas marcadas como “Somente MCP” na coluna de endpoint da API estão disponíveis apenas pelo servidor Braze MCP e não têm um endpoint público correspondente na REST API.
Espaços de trabalho
| Ferramenta |
Endpoint da API |
Acesso |
Permissão |
Descrição |
get_workspaces |
Somente MCP |
leitura |
Nenhuma |
Descobre quais espaços de trabalho da Braze o token de acesso OAuth atual pode acessar. Chame esta ferramenta primeiro: cada id de espaço de trabalho retornado é o app_group_id exigido por todas as outras ferramentas. |
Campaigns
| Ferramenta |
Endpoint da API |
Acesso |
Permissão |
Descrição |
get_campaign_list |
/campaigns/list |
leitura |
Visualizar análise de dados de campanhas |
Exporta uma lista de Campaigns com nome, identificador de API da Campaign, sinalizador de Campaign de API e tags. |
get_campaign_details |
/campaigns/details |
leitura |
Visualizar análise de dados de campanhas |
Recupera informações relevantes sobre uma Campaign específica pelo campaign_id. |
get_campaign_dataseries |
/campaigns/data_series |
leitura |
Visualizar análise de dados de campanhas |
Série diária de estatísticas da Campaign ao longo do tempo (envios, aberturas, cliques e conversões por canal). |
duplicate_campaign |
/campaigns/duplicate |
criação |
Criar campanhas |
Duplica uma Campaign existente. A cópia herda o Segment, o agendamento e o conteúdo da mensagem da original. |
create_campaign |
Somente MCP |
criação |
Criar campanhas |
Cria um rascunho de Campaign com direcionamento, agendamento, controles de entrega, eventos de conversão e limites de entrada. A Braze não lança Campaigns pelo servidor MCP, então lance o rascunho no dashboard da Braze. |
edit_campaign |
Somente MCP |
atualização |
Editar campanhas |
Edita os metadados de uma Campaign em rascunho ou ativa, como nome, direcionamento, agendamento, controles de entrega, eventos de conversão e limites de entrada. |
stop_campaign |
Somente MCP |
atualização |
Interromper campanhas |
Pausa a entrega de uma Campaign ativa, interrompendo os envios em andamento. Para retomá-la, lance a Campaign no dashboard da Braze. |
archive_campaign |
Somente MCP |
atualização |
Arquivar campanhas |
Arquiva uma Campaign, o que interrompe a entrega e marca a Campaign como excluída. Use unarchive_campaign para reverter. |
unarchive_campaign |
Somente MCP |
atualização |
Arquivar campanhas |
Desarquiva uma Campaign arquivada anteriormente. A Campaign volta no estado interrompido, então lance-a no dashboard da Braze para ativá-la novamente. |
get_campaign_draft |
Somente MCP |
leitura |
Visualizar análise de dados de campanhas |
Lê o rascunho editável de uma Campaign, incluindo direcionamento, canais, variações e controles de entrega. |
get_campaign_live_details |
Somente MCP |
leitura |
Visualizar análise de dados de campanhas |
Lê o estado ativo de uma Campaign lançada, no mesmo formato do rascunho. |
create_campaign_message |
Somente MCP |
criação |
Editar campanhas |
Adiciona um canal de mensagem ao rascunho de uma Campaign multicanal. |
update_campaign_message |
Somente MCP |
atualização |
Editar campanhas |
Atualiza um canal de mensagem no rascunho de uma Campaign multicanal. |
delete_campaign_message |
Somente MCP |
exclusão |
Editar campanhas |
Remove um canal de mensagem do rascunho de uma Campaign multicanal. |
create_campaign_message_variation |
Somente MCP |
criação |
Editar campanhas |
Adiciona uma variação A/B a uma Campaign tipada ou de push rápido. |
update_campaign_message_variation |
Somente MCP |
atualização |
Editar campanhas |
Atualiza uma variação A/B em uma Campaign tipada ou de push rápido. |
delete_campaign_message_variation |
Somente MCP |
exclusão |
Editar campanhas |
Remove uma variação A/B de uma Campaign tipada ou de push rápido. |
update_campaign_distribution |
Somente MCP |
atualização |
Editar campanhas |
Define a parcela do grupo de controle no rascunho de uma Campaign e a divisão percentual entre as variações A/B. |
get_campaign_translations |
Somente MCP |
leitura |
Visualizar análise de dados de campanhas |
Lê os mapas de tradução por localidade de uma variação de mensagem. |
get_campaign_translation_source |
Somente MCP |
leitura |
Visualizar análise de dados de campanhas |
Lê as strings de origem padrão dentro das tags {% translation id %} de uma variação. |
update_campaign_translation |
Somente MCP |
atualização |
Editar campanhas |
Grava as traduções de uma localidade para uma variação de mensagem. |
As ferramentas de Campaign estão disponíveis para todos e não exigem participação em um programa beta.
Canvas
| Ferramenta |
Endpoint da API |
Acesso |
Permissão |
Descrição |
get_canvas_list |
/canvas/list |
leitura |
Visualizar análise de dados do Canvas |
Exporta uma lista de Canvas com nome, identificador de API do Canvas e tags. |
get_canvas_details |
/canvas/details |
leitura |
Visualizar análise de dados do Canvas |
Exporta os metadados do Canvas: nome, horário de criação, status atual e mais. |
get_canvas_data_series |
/canvas/data_series |
leitura |
Visualizar análise de dados do Canvas |
Exporta dados de série temporal de um Canvas. |
get_canvas_data_summary |
/canvas/data_summary |
leitura |
Visualizar análise de dados do Canvas |
Exporta consolidações dos dados de série temporal do Canvas para um resumo conciso dos resultados. |
Catálogos
Atributos personalizados
| Ferramenta |
Endpoint da API |
Acesso |
Permissão |
Descrição |
get_custom_attributes |
/custom_attributes |
leitura |
Visualizar eventos personalizados, atributos e compras |
Exporta os atributos personalizados registrados para seu app, em grupos de 50, em ordem alfabética. |
Eventos personalizados
| Ferramenta |
Endpoint da API |
Acesso |
Permissão |
Descrição |
get_events |
/events |
leitura |
Visualizar eventos personalizados, atributos e compras |
Exporta os eventos personalizados registrados para seu app, em grupos de 50, em ordem alfabética (paginação por cursor). |
get_events_list |
/events/list |
leitura |
Visualizar eventos personalizados, atributos e compras |
Exporta os nomes de eventos personalizados, em grupos de 250, em ordem alfabética (paginação por página). |
get_events_data_series |
/events/data_series |
leitura |
Visualizar eventos personalizados, atributos e compras |
Ocorrências de um evento personalizado durante um período designado. |
Integrações de CDI
| Ferramenta |
Endpoint da API |
Acesso |
Permissão |
Descrição |
list_integrations |
/cdi/integrations |
leitura |
Visualizar status de trabalhos da ingestão de dados na nuvem |
Lista as integrações existentes de ingestão de dados na nuvem, 10 por chamada. |
get_integration_job_sync_status |
/cdi/integrations/{integration_id}/job_sync_status |
leitura |
Visualizar status de trabalhos da ingestão de dados na nuvem |
Status de sincronizações anteriores de uma determinada integração de CDI, 10 por chamada. |
trigger_integration_sync |
/cdi/integrations/{integration_id}/sync |
gravação |
Sincronizar integrações da ingestão de dados na nuvem |
Dispara uma sincronização para uma determinada integração de CDI. |
KPI
| Ferramenta |
Endpoint da API |
Acesso |
Permissão |
Descrição |
get_dau_data_series |
/kpi/dau/data_series |
leitura |
Visualizar dados de KPI |
Série diária de usuários ativos únicos por data. |
get_mau_data_series |
/kpi/mau/data_series |
leitura |
Visualizar dados de KPI |
Série diária de usuários ativos únicos em uma janela móvel de 30 dias. |
get_new_users_data_series |
/kpi/new_users/data_series |
leitura |
Visualizar dados de KPI |
Série diária do total de novos usuários por data. |
get_uninstalls_data_series |
/kpi/uninstalls/data_series |
leitura |
Visualizar dados de KPI |
Série diária do total de desinstalações por data. |
| Ferramenta |
Endpoint da API |
Acesso |
Permissão |
Descrição |
create_media_library_asset |
/media_library/create |
criação |
Gerenciar ativos da biblioteca de mídia |
Faz upload de um ativo para a biblioteca de mídia da Braze por URL externa ou conteúdo de arquivo em base64. É preciso informar exatamente um modo de upload. |
Compras
| Ferramenta |
Endpoint da API |
Acesso |
Permissão |
Descrição |
get_product_list |
/purchases/product_list |
leitura |
Visualizar eventos personalizados, atributos e compras |
Lista paginada de IDs de produtos. |
get_quantity_series |
/purchases/quantity_series |
leitura |
Visualizar eventos personalizados, atributos e compras |
Número total de compras no seu app em um intervalo de tempo. |
get_revenue_series |
/purchases/revenue_series |
leitura |
Visualizar eventos personalizados, atributos e compras |
Valor total gasto no seu app em um intervalo de tempo. |
Segments
| Ferramenta |
Endpoint da API |
Acesso |
Permissão |
Descrição |
get_segment_list |
/segments/list |
leitura |
Visualizar segmentos |
Exporta Segments com nome, identificador de API do Segment e sinalizador de rastreamento de análise de dados. |
get_segment_details |
/segments/details |
leitura |
Visualizar segmentos |
Recupera informações relevantes sobre um Segment pelo segment_id. |
get_segment_data_series |
/segments/data_series |
leitura |
Visualizar segmentos |
Série diária do tamanho estimado de um Segment ao longo do tempo. |
get_workspace_segments |
Somente MCP |
leitura |
Visualizar segmentos |
Lista os Segments ativos do espaço de trabalho como resumos, até 100 por chamada, com paginação por cursor. Segments arquivados e listas de supressão ficam de fora. |
get_segment_filters |
Somente MCP |
leitura |
Visualizar segmentos |
Descobre os filtros, as comparações e os tipos de valor válidos em uma árvore de filtros de Segment. |
create_segment |
Somente MCP |
criação |
Criar segmentos |
Cria um Segment definido pelo usuário a partir de uma árvore de filtros. |
edit_segment |
Somente MCP |
atualização |
Editar segmentos |
Edita um Segment existente definido pelo usuário. Informar um público substitui a árvore de filtros dele. |
archive_segment |
Somente MCP |
atualização |
Arquivar segmentos |
Arquiva um Segment e os Segments, Campaigns e Canvas que dependem dele. Chame primeiro sem cascade para revisar os dependentes. |
unarchive_segment |
Somente MCP |
atualização |
Arquivar segmentos |
Desarquiva um Segment. Os dependentes arquivados junto com ele continuam arquivados. |
As ferramentas de Segment estão disponíveis para todos e não exigem participação em um programa beta.

Nota
As ferramentas MCP são a forma compatível de gerenciar Campaigns, Segments, tags e diretrizes da marca de forma programática. As APIs subjacentes que alimentam essas ferramentas não estão listadas na nossa documentação pública de API, e usá-las diretamente não é compatível. O suporte da Braze não pode ajudar com problemas decorrentes do uso direto dessas APIs. Para fluxos de trabalho de produção, use as ferramentas MCP.
| Ferramenta |
Endpoint da API |
Acesso |
Permissão |
Descrição |
get_workspace_tags |
Somente MCP |
leitura |
Visualizar tags |
Lista todas as tags ativas de um espaço de trabalho pelo nome completo, ordenadas por nome, em uma única resposta sem paginação. O nome de uma tag aninhada é o caminho completo dela, como Seasonal/Spring. |
create_workspace_tag |
Somente MCP |
criação |
Editar tags |
Cria uma tag em um espaço de trabalho, no nível superior ou aninhada em uma tag existente, e retorna o nome completo dela. Um nome que só uma tag excluída tem recupera essa tag. Se uma tag ativa já tiver esse nome, com qualquer combinação de maiúsculas e minúsculas, a chamada falha com um erro 409 e nada é alterado. |
As ferramentas de tag estão disponíveis para todos e não exigem participação em um programa beta.
Diretrizes da marca
| Ferramenta |
Endpoint da API |
Acesso |
Permissão |
Descrição |
get_brand_guidelines |
Somente MCP |
leitura |
Nenhuma |
Lista as diretrizes da marca ativas de um espaço de trabalho, das atualizadas mais recentemente para as mais antigas, sem o texto das diretrizes, e indica qual delas é a padrão. |
get_default_brand_guideline |
Somente MCP |
leitura |
Nenhuma |
Obtém a diretriz da marca padrão de um espaço de trabalho com o texto dela, em uma única chamada. Se o espaço de trabalho não tiver uma diretriz padrão, a chamada retorna o erro DEFAULT_BRAND_GUIDELINE_NOT_SET. |
get_brand_guideline |
Somente MCP |
leitura |
Nenhuma |
Obtém uma diretriz da marca com o texto dela, inclusive uma diretriz arquivada. |
As ferramentas de diretrizes da marca estão disponíveis para todos e não exigem participação em um programa beta. Essas ferramentas são somente leitura. Para criar ou editar diretrizes da marca, use o dashboard da Braze.
Envios
| Ferramenta |
Endpoint da API |
Acesso |
Permissão |
Descrição |
get_send_data_series |
/sends/data_series |
leitura |
Visualizar dados de envio |
Estatísticas diárias de um send_id rastreado (Campaigns de API). A Braze armazena a análise de dados de envio por 14 dias após o envio. |
Sessões
| Ferramenta |
Endpoint da API |
Acesso |
Permissão |
Descrição |
get_session_data_series |
/sessions/data_series |
leitura |
Visualizar dados de sessão |
Número de sessões do seu app durante um período designado. |
Modelos
| Ferramenta |
Endpoint da API |
Acesso |
Permissão |
Descrição |
get_email_templates |
/templates/email/list |
leitura |
Visualizar modelos de e-mail |
Lista os modelos de e-mail disponíveis na sua conta da Braze. |
get_email_template_info |
/templates/email/info |
leitura |
Visualizar modelos de e-mail |
Obtém informações de um modelo de e-mail específico. Modelos do editor de arrastar e soltar não são aceitos. |
create_email_template |
/templates/email/create |
criação |
Gerenciar modelos de e-mail |
Cria um modelo de e-mail no dashboard da Braze. |
update_email_template |
/templates/email/update |
atualização |
Gerenciar modelos de e-mail |
Atualiza um modelo de e-mail existente. |
Blocos de conteúdo
| Ferramenta |
Endpoint da API |
Acesso |
Permissão |
Descrição |
get_content_blocks |
/content_blocks/list |
leitura |
Visualizar blocos de conteúdo |
Lista as informações dos blocos de conteúdo existentes. |
get_content_block_info |
/content_blocks/info |
leitura |
Visualizar blocos de conteúdo |
Obtém informações de um bloco de conteúdo existente, opcionalmente com dados de inclusão em Campaigns ou Canvas. |
create_content_block |
/content_blocks/create |
criação |
Gerenciar blocos de conteúdo |
Cria um bloco de conteúdo. |
update_content_block |
/content_blocks/update |
atualização |
Gerenciar blocos de conteúdo |
Atualiza um bloco de conteúdo. |
Operator
| Ferramenta |
Endpoint da API |
Acesso |
Permissão |
Descrição |
send_operator_prompt |
Somente MCP |
atualização |
Usar o BrazeAI Operator |
Envia um prompt em linguagem natural para o BrazeAI Operator. Envia um trabalho em segundo plano e retorna um job_id. |
get_operator_result |
Somente MCP |
leitura |
Usar o BrazeAI Operator |
Consulta o resultado de um trabalho do Operator enviado usando o job_id dele. |
cancel_operator_job |
Somente MCP |
atualização |
Usar o BrazeAI Operator |
Cancela um trabalho do Operator em execução. |

Importante
Essas ferramentas estão disponíveis apenas para clientes que participam do programa beta do Operator. Se esse recurso não estiver ativado na sua conta, você poderá receber um erro ao tentar usá-lo. Para participar do programa beta, entre em contato com seu gerente de conta.
Skills
| Ferramenta |
Endpoint da API |
Acesso |
Permissão |
Descrição |
get_operator_skills |
Somente MCP |
leitura |
Visualizar Skills |
Lista as skills do espaço de trabalho, com o nome e a descrição de cada uma. |
get_operator_skill |
Somente MCP |
leitura |
Visualizar Skills |
Lê uma skill, incluindo as instruções dela. |
create_operator_skill |
Somente MCP |
criação |
Visualizar Skills, Editar Skills |
Cria uma skill. Se o nome já estiver em uso, a Braze adiciona um sufixo. |
update_operator_skill |
Somente MCP |
atualização |
Visualizar Skills, Editar Skills |
Edita uma skill. Os campos que você não informar mantêm os valores atuais. |
Para saber mais, consulte Skills.
Aviso legal
Como instruções e respostas são tratadas
O servidor MCP da Braze recebe instruções do seu cliente MCP de provedor terceiro, como Claude, ChatGPT, Copilot, Gemini CLI, Codex ou Cursor, exatamente como o modelo de IA subjacente desse provedor as formula. Quando você digita uma solicitação em linguagem natural, o modelo de IA interpreta sua solicitação e a traduz em uma ou mais chamadas de ferramenta específicas para a Braze. A Braze recebe e executa a chamada de ferramenta conforme enviada. A Braze não vê seu prompt original em linguagem natural e não pode verificar se a chamada de ferramenta gerada reflete total ou precisamente a sua solicitação pretendida.
Quando a Braze retorna dados ou um resultado, essa resposta é enviada de volta ao seu cliente MCP de provedor terceiro, que então interpreta, formata e apresenta as informações para você. A Braze não controla como o modelo de IA apresenta, resume ou descreve as informações retornadas.
A Braze não é responsável por instruções geradas por, ou respostas transmitidas por meio de, qualquer cliente MCP de provedor terceiro. A Braze recomenda não usar o “modo automático” caso seu cliente MCP de provedor terceiro o ofereça para implementação automática de ações. Revise os resumos gerados por IA comparando-os com os dados de origem no seu dashboard da Braze e revise qualquer ação proposta pela IA antes de implementá-la por meio do seu cliente MCP de provedor terceiro.