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 um conjunto de funções de API que mapeiam para endpoints específicos da REST API da Braze. Clientes MCP como Claude e Cursor podem chamar essas funções para recuperar dados sem IPI e, com as permissões adequadas, realizar ações de escrita sem IPI. Para mais informações gerais, veja servidor Braze MCP.

Importante

O servidor MCP da Braze está em beta. Você não precisa solicitar acesso para usá-lo. Siga as instruções de configuração para começar. Ao usar o servidor MCP da Braze, você concorda com os Termos Beta da Braze. Para nos ajudar a melhorá-lo, envie seu feedback para [email protected].

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 referencia as seguintes funções de API para interagir com o servidor Braze MCP.

Funções gerais

Essas funções ajudam seu cliente MCP a descobrir e executar as funções de API da Braze disponíveis.

Função	Descrição
`list_functions`	Lista todas as funções de API da Braze disponíveis com suas descrições e parâmetros.
`call_function`	Chama uma função específica de API da Braze somente leitura com os parâmetros fornecidos.
`call_write_function`	Chama uma função específica de API da Braze com capacidade de escrita com os parâmetros fornecidos.

Campaigns

Função	Endpoint	Descrição
`get_campaign_list`	`/campaigns/list`	Exporta uma lista de Campaigns com metadados.
`get_campaign_details`	`/campaigns/details`	Obtém informações detalhadas sobre Campaigns específicas.
`get_campaign_dataseries`	`/campaigns/data_series`	Recupera dados de análise de séries temporais para Campaigns.

Canvas

Função	Endpoint	Descrição
`get_canvas_list`	`/canvas/list`	Exporta uma lista de Canvas com metadados.
`get_canvas_details`	`/canvas/details`	Obtém informações detalhadas sobre Canvas específicos.
`get_canvas_data_summary`	`/canvas/data_summary`	Obtém análises resumidas para o desempenho do Canvas.
`get_canvas_data_series`	`/canvas/data_series`	Recupera dados de análise de séries temporais para Canvas.

Catálogos

Função	Endpoint	Descrição
`get_catalogs`	`/catalogs`	Retorna uma lista de catálogos em um espaço de trabalho.
`get_catalog_items`	`/catalogs/{catalog_name}/items`	Retorna vários itens de catálogo e seu conteúdo com suporte à paginação.
`get_catalog_item`	`/catalogs/{catalog_name}/items/{item_id}`	Retorna um item de catálogo específico e seu conteúdo por ID.

Ingestão de dados na nuvem

Função	Endpoint	Descrição
`list_integrations`	`/cdi/integrations`	Retorna uma lista de integrações CDI existentes.
`get_integration_job_sync_status`	`/cdi/integrations/{integration_id}/job_sync_status`	Retorna os status de sincronização anteriores para uma integração CDI específica.

Content Blocks

As funções create_content_block e update_content_block são funções de escrita. Seu cliente MCP deve chamá-las com call_write_function, e sua chave de API deve ter a permissão correspondente content_blocks.create ou content_blocks.update.

Função	Endpoint	Descrição
`get_content_blocks_list`	`/content_blocks/list`	Lista seus blocos de conteúdo disponíveis.
`get_content_blocks_info`	`/content_blocks/info`	Obtém informações sobre seus blocos de conteúdo.
`create_content_block`	`/content_blocks/create`	Cria um bloco de conteúdo. Requer `name` e `content`. Campos opcionais são `description`, `state` (deve ser `active` ou `draft`) e `tags`.
`update_content_block`	`/content_blocks/update`	Atualiza um bloco de conteúdo existente. Requer `content_block_id` e pelo menos um campo atualizável: `name`, `content`, `description`, `state` (deve ser `active` ou `draft`) ou `tags`.

Atributos personalizados

Função	Endpoint	Descrição
`get_custom_attributes`	`/custom_attributes`	Exporta atributos personalizados registrados para seu app.

Eventos

Função	Endpoint	Descrição
`get_events_list`	`/events/list`	Exporta uma lista de eventos personalizados registrados para seu app.
`get_events_data_series`	`/events/data_series`	Recupera dados de séries temporais para eventos personalizados.
`get_events`	`/events`	Obtém dados detalhados de eventos com suporte à paginação.

KPIs

Função	Endpoint	Descrição
`get_new_users_data_series`	`/kpi/new_users/data_series`	Série diária de contagem de novos usuários.
`get_dau_data_series`	`/kpi/dau/data_series`	Dados de séries temporais de usuários ativos diários.
`get_mau_data_series`	`/kpi/mau/data_series`	Dados de séries temporais de usuários ativos mensais.
`get_uninstalls_data_series`	`/kpi/uninstalls/data_series`	Dados de séries temporais de desinstalações do app.

Biblioteca de mídia

A função create_media_library_asset é uma função de escrita. Seu cliente MCP deve chamá-la com call_write_function, e sua chave de API deve ter a permissão media_library.create.

Função	Endpoint	Descrição
`create_media_library_asset`	`/media_library/create`	Faz upload de um ativo para sua Biblioteca de mídia da Braze. Você pode fornecer uma URL acessível publicamente (`asset_url`) ou um arquivo codificado em base64 (`asset_file_base64`), mas não ambos. Imagens têm um limite de tamanho de 5 MB.

Mensagens

Função	Endpoint	Descrição
`get_scheduled_broadcasts`	`/messages/scheduled_broadcasts`	Lista Campaigns e Canvas agendados.

Centrais de Preferências

Função	Endpoint	Descrição
`get_preference_centers`	`/preference_center/v1/list`	Lista suas Centrais de Preferências disponíveis.
`get_preference_center_details`	`/preference_center/v1/{preferenceCenterExternalID}`	Exibe detalhes de uma Central de Preferências específica, incluindo conteúdo HTML e opções.

Compras

Função	Endpoint	Descrição
`get_product_list`	`/purchases/product_list`	Exporta lista paginada de IDs de produtos.
`get_revenue_series`	`/purchases/revenue_series`	Dados de séries temporais de análise de receita.
`get_quantity_series`	`/purchases/quantity_series`	Dados de séries temporais de quantidade de compras.

Segments

Função	Endpoint	Descrição
`get_segment_list`	`/segments/list`	Exporta lista de Segments com status de rastreamento de análise.
`get_segment_data_series`	`/segments/data_series`	Dados de análise de séries temporais para Segments.
`get_segment_details`	`/segments/details`	Informações detalhadas sobre Segments específicos.

Envios

Função	Endpoint	Descrição
`get_send_data_series`	`/sends/data_series`	Análise de dados diária para envios de Campaigns rastreadas.

Sessões

Função	Endpoint	Descrição
`get_session_data_series`	`/sessions/data_series`	Dados de séries temporais para contagem de sessões do app.

Chaves de Autenticação do SDK

Função	Endpoint	Descrição
`get_sdk_authentication_keys`	`/app_group/sdk_authentication/keys`	Lista todas as chaves de autenticação do SDK para seu app.

Inscrição

Função	Endpoint	Descrição
`get_user_subscription_groups`	`/subscription/user/status`	Lista e obtém os grupos de inscrições de um determinado usuário.
`get_subscription_group_status`	`/subscription/status/get`	Obtém o estado da inscrição de um usuário em um grupo de inscrições.

Modelos

As funções create_email_template e update_email_template são funções de escrita. Seu cliente MCP deve chamá-las com call_write_function, e sua chave de API deve ter a permissão correspondente templates.email.create ou templates.email.update.

Função	Endpoint	Descrição
`get_email_templates_list`	`/templates/email/list`	Lista seus modelos de e-mail disponíveis.
`get_email_template_info`	`/templates/email/info`	Obtém informações sobre seus modelos de e-mail.
`create_email_template`	`/templates/email/create`	Cria um modelo de e-mail. Requer `template_name`, `subject` e `body`. Campos opcionais são `plaintext_body`, `preheader`, `tags` e `should_inline_css`.
`update_email_template`	`/templates/email/update`	Atualiza um modelo de e-mail existente. Requer `email_template_id` e pelo menos um campo atualizável: `template_name`, `subject`, `body`, `plaintext_body`, `preheader`, `tags` ou `should_inline_css`.

Aviso Legal

O Model Context Protocol (MCP) é um protocolo de código aberto recém-introduzido que pode estar suscetível a problemas de segurança ou vulnerabilidades neste momento.

O código e as instruções de configuração do servidor MCP da Braze são fornecidos pela Braze “no estado em que se encontram” e sem quaisquer 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 potenciais problemas de segurança 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 do seu ambiente Braze.

Para assistência ou esclarecimentos, fale com o suporte da Braze.

New Stuff!