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 expõe 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. Se você tentar acessar uma ferramenta que faz parte 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. Elas 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 que todas as outras ferramentas exigem. |
Campaigns
| Ferramenta |
Endpoint da API |
Acesso |
Permissão |
Descrição |
get_campaign_list |
/campaigns/list |
leitura |
Ver análise de dados de Campaigns |
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 |
Ver análise de dados de Campaigns |
Recupera informações relevantes sobre uma Campaign específica pelo campaign_id. |
get_campaign_dataseries |
/campaigns/data_series |
leitura |
Ver análise de dados de Campaigns |
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 Campaigns |
Duplica uma Campaign existente. |
create_campaign |
Somente MCP |
criação |
Criar Campaigns |
Cria uma nova Campaign. |
edit_campaign |
Somente MCP |
atualização |
Editar Campaigns |
Edita uma Campaign existente. |
launch_campaign* |
Somente MCP |
atualização |
Lançar Campaigns |
Lança uma Campaign. |
stop_campaign |
Somente MCP |
atualização |
Interromper Campaigns |
Interrompe uma Campaign em execução. |
archive_campaign* |
Somente MCP |
atualização |
Arquivar Campaigns |
Arquiva uma Campaign. |
unarchive_campaign* |
Somente MCP |
atualização |
Arquivar Campaigns |
Desarquiva uma Campaign. |
get_campaign_draft |
Somente MCP |
leitura |
Ver análise de dados de Campaigns |
Recupera os detalhes do rascunho de uma Campaign. |
get_campaign_live_details |
Somente MCP |
leitura |
Ver análise de dados de Campaigns |
Recupera os detalhes de uma campanha ativa. |
create_campaign_message |
Somente MCP |
criação |
Editar Campaigns |
Cria uma mensagem dentro de uma Campaign. |
update_campaign_message |
Somente MCP |
atualização |
Editar Campaigns |
Atualiza uma mensagem de Campaign. |
delete_campaign_message |
Somente MCP |
exclusão |
Editar Campaigns |
Exclui uma mensagem de Campaign. |
create_campaign_message_variation |
Somente MCP |
criação |
Editar Campaigns |
Cria uma variação de mensagem dentro de uma Campaign. |
update_campaign_message_variation |
Somente MCP |
atualização |
Editar Campaigns |
Atualiza uma variação de mensagem de Campaign. |
delete_campaign_message_variation |
Somente MCP |
exclusão |
Editar Campaigns |
Exclui uma variação de mensagem de Campaign. |
update_campaign_distribution |
Somente MCP |
atualização |
Editar Campaigns |
Atualiza as configurações de distribuição da Campaign. |
As ferramentas de Campaign estão disponíveis para todos e não exigem participação em um programa beta, exceto as ferramentas marcadas com asterisco (*).
* Esta ferramenta está disponível apenas para clientes que participam do programa beta das APIs de Campaign. Se sua conta não tiver esse recurso ativado, você poderá receber um erro ao tentar usá-la. Para participar do programa beta, entre em contato com seu gerente de conta.
Canvas
| Ferramenta |
Endpoint da API |
Acesso |
Permissão |
Descrição |
get_canvas_list |
/canvas/list |
leitura |
Ver 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 |
Ver análise de dados do Canvas |
Exporta metadados do Canvas: nome, data de criação, status atual e muito mais. |
get_canvas_data_series |
/canvas/data_series |
leitura |
Ver análise de dados do Canvas |
Exporta dados de série temporal de um Canvas. |
get_canvas_data_summary |
/canvas/data_summary |
leitura |
Ver análise de dados do Canvas |
Exporta agregaçõ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 |
Ver 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 |
Ver 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 |
Ver eventos personalizados, atributos e compras |
Exporta os nomes dos eventos personalizados, em grupos de 250, em ordem alfabética (paginação por página). |
get_events_data_series |
/events/data_series |
leitura |
Ver eventos personalizados, atributos e compras |
Ocorrências de um evento personalizado em um período designado. |
Integrações CDI
| Ferramenta |
Endpoint da API |
Acesso |
Permissão |
Descrição |
list_integrations |
/cdi/integrations |
leitura |
Ver status de trabalhos de Cloud Data Ingestion |
Lista as integrações existentes de Cloud Data Ingestion, 10 por chamada. |
get_integration_job_sync_status |
/cdi/integrations/{integration_id}/job_sync_status |
leitura |
Ver status de trabalhos de Cloud Data Ingestion |
Status de sincronizações anteriores de uma integração CDI, 10 por chamada. |
trigger_integration_sync |
/cdi/integrations/{integration_id}/sync |
gravação |
Sincronizar integrações de Cloud Data Ingestion |
Dispara uma sincronização para uma integração CDI. |
KPI
| Ferramenta |
Endpoint da API |
Acesso |
Permissão |
Descrição |
get_dau_data_series |
/kpi/dau/data_series |
leitura |
Ver dados de KPI |
Série diária de usuários ativos únicos por data. |
get_mau_data_series |
/kpi/mau/data_series |
leitura |
Ver 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 |
Ver dados de KPI |
Série diária do total de novos usuários por data. |
get_uninstalls_data_series |
/kpi/uninstalls/data_series |
leitura |
Ver 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 meio de 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 |
Ver eventos personalizados, atributos e compras |
Lista paginada de IDs de produtos. |
get_quantity_series |
/purchases/quantity_series |
leitura |
Ver 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 |
Ver 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 |
Ver Segments |
Exporta Segments com nome, identificador de API do Segment e sinalizador de rastreamento de análise de dados. |
get_segment_details |
/segments/details |
leitura |
Ver Segments |
Recupera informações relevantes sobre um Segment pelo segment_id. |
get_segment_data_series |
/segments/data_series |
leitura |
Ver Segments |
Série diária do tamanho estimado de um Segment ao longo do tempo. |
get_segment_filters |
Somente MCP |
leitura |
Ver Segments |
Recupera as definições de filtros de Segment. |
create_segment |
Somente MCP |
criação |
Criar Segments |
Cria um novo Segment. |
edit_segment |
Somente MCP |
atualização |
Editar Segments |
Edita um Segment existente. |
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 e Segments de maneira programática. As APIs subjacentes que alimentam essas ferramentas não estão listadas na nossa documentação pública da API, e o uso direto delas não é compatível. O suporte da Braze não pode ajudar com problemas decorrentes do uso direto dessas APIs, a menos que sua empresa esteja inscrita no beta da API. Para fluxos de trabalho em produção, use as ferramentas MCP.
Envios
| Ferramenta |
Endpoint da API |
Acesso |
Permissão |
Descrição |
get_send_data_series |
/sends/data_series |
leitura |
Ver 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 |
Ver dados de sessão |
Número de sessões do seu app em um período designado. |
Modelos
| Ferramenta |
Endpoint da API |
Acesso |
Permissão |
Descrição |
get_email_templates |
/templates/email/list |
leitura |
Ver modelos de e-mail |
Lista os modelos de e-mail disponíveis na sua conta Braze. |
get_email_template_info |
/templates/email/info |
leitura |
Ver modelos de e-mail |
Obtém informações sobre 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 |
Ver blocos de conteúdo |
Lista as informações dos blocos de conteúdo existentes. |
get_content_block_info |
/content_blocks/info |
leitura |
Ver blocos de conteúdo |
Obtém informações sobre um bloco de conteúdo existente, opcionalmente com dados de inclusão em Campaign 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 sua conta não tiver esse recurso ativado, você poderá receber um erro ao tentar usá-las. Para participar do programa beta, entre em contato com seu gerente de conta.
Habilidades
| Ferramenta |
Endpoint da API |
Acesso |
Permissão |
Descrição |
get_operator_skills |
Somente MCP |
leitura |
Ver habilidades |
Lista as habilidades do espaço de trabalho, com o nome e a descrição de cada uma. |
get_operator_skill |
Somente MCP |
leitura |
Ver habilidades |
Lê uma habilidade, incluindo as instruções dela. |
create_operator_skill |
Somente MCP |
criação |
Ver habilidades, Editar habilidades |
Cria uma habilidade. Se o nome já estiver em uso, a Braze adiciona um sufixo. |
update_operator_skill |
Somente MCP |
atualização |
Ver habilidades, Editar habilidades |
Edita uma habilidade. Os campos que você não informar mantêm os valores atuais. |
Para saber mais, consulte Habilidades.
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.