Skip to content

Funções do servidor Braze MCP

O servidor Braze MCP expõe ferramentas de leitura e escrita que mapeiam para endpoints específicos da REST API da Braze. Para saber mais, veja servidor Braze MCP.

Pré-requisitos

Antes de usar esse recurso, você precisará configurar o servidor Braze MCP.

Funções de API Braze disponíveis

Seu cliente MCP faz referência a essas ferramentas para interagir com o servidor Braze MCP.

Espaços de trabalho

Ferramenta Endpoint de API Acesso Descrição
get_workspaces N/A leitura Descobre quais espaços de trabalho da Braze o token de acesso OAuth atual pode alcançar. Chame esta função primeiro: cada id de espaço de trabalho retornado é o app_group_id que todas as outras ferramentas exigem.

Campaigns

Ferramenta Endpoint de API Acesso Descrição
get_campaign_list /campaigns/list leitura Exporta uma lista de Campaigns com nome, identificador de API da Campaign, flag de API-campaign e tags.
get_campaign_details /campaigns/details leitura Recupera informações relevantes sobre uma Campaign específica pelo campaign_id.
get_campaign_dataseries /campaigns/data_series leitura Série diária de estatísticas da Campaign ao longo do tempo (envios, aberturas, cliques, conversões por canal).
duplicate_campaign /campaigns/duplicate criação Duplica uma Campaign existente.
create_campaign* N/A criação Cria uma nova Campaign.
edit_campaign* N/A atualização Edita uma Campaign existente.
launch_campaign* N/A atualização Lança uma Campaign.
stop_campaign* N/A atualização Interrompe uma Campaign em execução.
archive_campaign* N/A atualização Arquiva uma Campaign.
unarchive_campaign* N/A atualização Desarquiva uma Campaign.
get_campaign_draft* N/A leitura Recupera os detalhes do rascunho de uma Campaign.
get_campaign_live_details* N/A leitura Recupera os detalhes de uma Campaign ativa.
create_campaign_message* N/A criação Cria uma mensagem dentro de uma Campaign.
update_campaign_message* N/A atualização Atualiza uma mensagem de Campaign.
delete_campaign_message* N/A exclusão Exclui uma mensagem de Campaign.
create_campaign_message_variation* N/A criação Cria uma variação de mensagem dentro de uma Campaign.
update_campaign_message_variation* N/A atualização Atualiza uma variação de mensagem de Campaign.
delete_campaign_message_variation* N/A exclusão Exclui uma variação de mensagem de Campaign.
update_campaign_distribution* N/A atualização Atualiza as configurações de distribuição de uma Campaign.

* Esta ferramenta está disponível apenas para clientes que participam do programa beta de APIs de Campaign. Se a sua conta não tem este recurso ativado, você pode receber um erro ao tentar usá-la. Para participar do programa beta, entre em contato com o seu gerente de conta.

Canvas

Ferramenta Endpoint de API Acesso Descrição
get_canvas_list /canvas/list leitura Exporta uma lista de Canvas com nome, identificador de API do Canvas e tags.
get_canvas_details /canvas/details leitura Exporta metadados do Canvas: nome, data de criação, status atual e mais.
get_canvas_data_series /canvas/data_series leitura Exporta dados de série temporal para um Canvas.
get_canvas_data_summary /canvas/data_summary leitura Exporta resumos consolidados dos dados de série temporal de um Canvas para uma visão concisa dos resultados.

Catálogos

Ferramenta Endpoint de API Acesso Descrição
get_catalogs /catalogs leitura Lista catálogos em um espaço de trabalho.
get_catalog_items /catalogs/{catalog_name}/items leitura Retorna múltiplos itens de catálogo e seus conteúdos.
get_catalog_item /catalogs/{catalog_name}/items/{item_id} leitura Retorna um único item de catálogo e seu conteúdo.
create_catalog /catalogs criação Cria um catálogo.
delete_catalog /catalogs/{catalog_name} exclusão Exclui um catálogo.
create_catalog_fields /catalogs/{catalog_name}/fields criação Cria múltiplos campos em um catálogo.
delete_catalog_field /catalogs/{catalog_name}/fields/{field_name} exclusão Exclui um campo de catálogo.
create_catalog_items /catalogs/{catalog_name}/items criação Cria múltiplos itens em um catálogo. Até 50 itens por requisição.
edit_catalog_items /catalogs/{catalog_name}/items atualização Edita múltiplos itens existentes em um catálogo. Até 50 itens por requisição.
replace_catalog_items /catalogs/{catalog_name}/items atualização Substitui múltiplos itens em um catálogo. Cria itens caso não existam. Até 50 itens por requisição.
delete_catalog_items /catalogs/{catalog_name}/items exclusão Exclui múltiplos itens em um catálogo. Até 50 itens por requisição.
create_catalog_selection /catalogs/{catalog_name}/selections criação Cria uma seleção em um catálogo.
delete_catalog_selection /catalogs/{catalog_name}/selections/{selection_name} exclusão Exclui uma seleção de catálogo.

Atributos personalizados

Ferramenta Endpoint de API Acesso Descrição
get_custom_attributes /custom_attributes leitura Exporta atributos personalizados registrados para o seu app, em grupos de 50, em ordem alfabética.

Eventos personalizados

Ferramenta Endpoint de API Acesso Descrição
get_events /events leitura Exporta eventos personalizados registrados para o seu app, em grupos de 50, em ordem alfabética (paginação por cursor).
get_events_list /events/list leitura Exporta 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 Ocorrências de um evento personalizado em um período designado.

Integrações CDI

Ferramenta Endpoint de API Acesso Descrição
list_integrations /cdi/integrations leitura Lista integrações existentes de Cloud Data Ingestion, 10 por chamada.
get_integration_job_sync_status /cdi/integrations/{integration_id}/job_sync_status leitura Status de sincronizações anteriores para uma integração CDI específica, 10 por chamada.
trigger_integration_sync /cdi/integrations/{integration_id}/sync escrita Dispara uma sincronização para uma integração CDI específica.

KPI

Ferramenta Endpoint de API Acesso Descrição
get_dau_data_series /kpi/dau/data_series leitura Série diária de usuários ativos únicos por data.
get_mau_data_series /kpi/mau/data_series leitura 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 Série diária do total de novos usuários por data.
get_uninstalls_data_series /kpi/uninstalls/data_series leitura Série diária do total de desinstalações por data.

Biblioteca de mídia

Ferramenta Endpoint de API Acesso Descrição
create_media_library_asset /media_library/create criação Faz upload de um ativo para a biblioteca de mídia da Braze por URL externo ou conteúdo de arquivo em base64. Exatamente um modo de upload deve ser fornecido.

Compras

Ferramenta Endpoint de API Acesso Descrição
get_product_list /purchases/product_list leitura Lista paginada de IDs de produtos.
get_quantity_series /purchases/quantity_series leitura Número total de compras no seu app em um intervalo de tempo.
get_revenue_series /purchases/revenue_series leitura Total de dinheiro gasto no seu app em um intervalo de tempo.

Segments

Ferramenta Endpoint de API Acesso Descrição
get_segment_list /segments/list leitura Exporta Segments com nome, identificador de API do Segment e flag de rastreamento analítico.
get_segment_details /segments/details leitura Recupera informações relevantes sobre um Segment pelo segment_id.
get_segment_data_series /segments/data_series leitura Série diária do tamanho estimado de um Segment ao longo do tempo.
get_segment_filters* N/A leitura Recupera definições de filtros de Segment.
create_segment* N/A criação Cria um novo Segment.
edit_segment* N/A atualização Edita um Segment existente.

* Esta ferramenta está disponível apenas para clientes que participam do programa beta de APIs de Segment. Se a sua conta não tem este recurso ativado, você pode receber um erro ao tentar usá-la. Para participar do programa beta, entre em contato com o seu gerente de conta.

Envios

Ferramenta Endpoint de API Acesso Descrição
get_send_data_series /sends/data_series leitura Estatísticas diárias para um send_id rastreado (Campaigns de API). A Braze armazena análises de envio por 14 dias após o envio.

Sessões

Ferramenta Endpoint de API Acesso Descrição
get_session_data_series /sessions/data_series leitura Número de sessões do seu app em um período designado.

Modelos

Ferramenta Endpoint de API Acesso Descrição
get_email_templates /templates/email/list leitura Lista os modelos de e-mail disponíveis na sua conta Braze.
get_email_template_info /templates/email/info leitura 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 Cria um modelo de e-mail no dashboard da Braze.
update_email_template /templates/email/update atualização Atualiza um modelo de e-mail existente.

Content Blocks

Ferramenta Endpoint de API Acesso Descrição
get_content_blocks /content_blocks/list leitura Lista informações de Content Blocks existentes.
get_content_block_info /content_blocks/info leitura Obtém informações de um Content Block existente, opcionalmente com dados de inclusão em Campaigns ou Canvas.
create_content_block /content_blocks/create criação Cria um Content Block.
update_content_block /content_blocks/update atualização Atualiza um Content Block.

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.

New Stuff!