Skip to content

Braze MCP server functions

The Braze MCP server exposes read and write tools. Most map to Braze REST API endpoints. Some are available only through the MCP server. For more information, see Braze MCP server.

Prerequisites

Before you can use this feature, you’ll need to set up the Braze MCP server.

Available Braze API functions

Your MCP client references these tools to interact with the Braze MCP server. Tools labeled “MCP only” in the API endpoint column are available only through the Braze MCP server. They don’t have a corresponding public REST API endpoint.

Workspaces

Tool API endpoint Access Permission Description
get_workspaces MCP only read None Discover which Braze workspaces the current OAuth access token can reach. Call this first: each returned workspace id is the app_group_id every other tool requires.

Campaigns

Tool API endpoint Access Permission Description
get_campaign_list /campaigns/list read View campaign analytics Export a list of campaigns with name, campaign API identifier, API-campaign flag, and tags.
get_campaign_details /campaigns/details read View campaign analytics Retrieve relevant information on a specified campaign by campaign_id.
get_campaign_dataseries /campaigns/data_series read View campaign analytics Daily series of campaign stats over time (sends, opens, clicks, conversions by channel).
duplicate_campaign /campaigns/duplicate create Create campaigns Duplicate an existing campaign. The copy inherits the segment, schedule, and message content of the original.
create_campaign MCP only create Create campaigns Create a campaign draft with targeting, schedule, delivery controls, conversion events, and entry limits. Braze doesn’t launch campaigns through the MCP server, so launch the draft from the Braze dashboard.
edit_campaign MCP only update Edit campaigns Edit the metadata of a draft or live campaign, such as name, targeting, schedule, delivery controls, conversion events, and entry limits.
stop_campaign MCP only update Stop campaigns Pause delivery on a live campaign, stopping in-flight sending. To resume it, launch the campaign from the Braze dashboard.
archive_campaign MCP only update Archive campaigns Archive a campaign, which stops delivery and marks the campaign deleted. Use unarchive_campaign to reverse this.
unarchive_campaign MCP only update Archive campaigns Unarchive a previously archived campaign. The campaign returns in a stopped state, so launch it from the Braze dashboard to make it live again.
get_campaign_draft MCP only read View campaign analytics Read a campaign’s editable draft, including targeting, channels, variations, and delivery controls.
get_campaign_live_details MCP only read View campaign analytics Read a launched campaign’s live state, in the same shape as the draft.
create_campaign_message MCP only create Edit campaigns Add a message channel to a mixed-channel campaign’s draft.
update_campaign_message MCP only update Edit campaigns Update a message channel on a mixed-channel campaign’s draft.
delete_campaign_message MCP only delete Edit campaigns Remove a message channel from a mixed-channel campaign’s draft.
create_campaign_message_variation MCP only create Edit campaigns Add an A/B variation to a typed or quick-push campaign.
update_campaign_message_variation MCP only update Edit campaigns Update one A/B variation on a typed or quick-push campaign.
delete_campaign_message_variation MCP only delete Edit campaigns Remove one A/B variation from a typed or quick-push campaign.
update_campaign_distribution MCP only update Edit campaigns Set a campaign draft’s control group share and the percentage split across A/B variations.
get_campaign_translations MCP only read View campaign analytics Read the per-locale translation maps for a message variation.
get_campaign_translation_source MCP only read View campaign analytics Read the default source strings inside a variation’s {% translation id %} tags.
update_campaign_translation MCP only update Edit campaigns Write one locale’s translations for a message variation.

The campaign tools are generally available and don’t require you to join a beta program.

Canvases

Tool API endpoint Access Permission Description
get_canvas_list /canvas/list read View Canvas analytics Export a list of Canvases with name, Canvas API identifier, and tags.
get_canvas_details /canvas/details read View Canvas analytics Export Canvas metadata: name, time created, current status, and more.
get_canvas_data_series /canvas/data_series read View Canvas analytics Export time series data for a Canvas.
get_canvas_data_summary /canvas/data_summary read View Canvas analytics Export rollups of Canvas time series data for a concise results summary.

Catalogs

Tool API endpoint Access Permission Description
get_catalogs /catalogs read View catalogs List catalogs in a workspace.
get_catalog_items /catalogs/{catalog_name}/items read View catalog items Return multiple catalog items and their content.
get_catalog_item /catalogs/{catalog_name}/items/{item_id} read View catalog items Return a single catalog item and its content.
create_catalog /catalogs create Manage catalogs Create a catalog.
delete_catalog /catalogs/{catalog_name} delete Manage catalogs Delete a catalog.
create_catalog_fields /catalogs/{catalog_name}/fields create Manage catalog fields Create multiple fields in a catalog.
delete_catalog_field /catalogs/{catalog_name}/fields/{field_name} delete Manage catalog fields Delete a catalog field.
create_catalog_items /catalogs/{catalog_name}/items create Manage catalog items Create multiple items in a catalog. Up to 50 items per request.
edit_catalog_items /catalogs/{catalog_name}/items update Manage catalog items Edit multiple existing items in a catalog. Up to 50 items per request.
replace_catalog_items /catalogs/{catalog_name}/items update Manage catalog items Replace multiple items in a catalog. Creates items if they don’t exist. Up to 50 items per request.
delete_catalog_items /catalogs/{catalog_name}/items delete Manage catalog items Delete multiple items in a catalog. Up to 50 items per request.
create_catalog_selection /catalogs/{catalog_name}/selections create Manage catalog selections Create a selection in a catalog.
delete_catalog_selection /catalogs/{catalog_name}/selections/{selection_name} delete Manage catalog selections Delete a catalog selection.

Custom attributes

Tool API endpoint Access Permission Description
get_custom_attributes /custom_attributes read View custom events, attributes, and purchases Export custom attributes recorded for your app, in groups of 50, alphabetical.

Custom events

Tool API endpoint Access Permission Description
get_events /events read View custom events, attributes, and purchases Export custom events recorded for your app, in groups of 50, alphabetical (cursor pagination).
get_events_list /events/list read View custom events, attributes, and purchases Export custom event names, in groups of 250, alphabetical (page pagination).
get_events_data_series /events/data_series read View custom events, attributes, and purchases Occurrences of a custom event over a designated time period.

CDI integrations

Tool API endpoint Access Permission Description
list_integrations /cdi/integrations read View Cloud Data Ingestion job status List existing Cloud Data Ingestion integrations, 10 per call.
get_integration_job_sync_status /cdi/integrations/{integration_id}/job_sync_status read View Cloud Data Ingestion job status Past sync statuses for a given CDI integration, 10 per call.
trigger_integration_sync /cdi/integrations/{integration_id}/sync write Sync Cloud Data Ingestion integrations Trigger a sync for a given CDI integration.

KPI

Tool API endpoint Access Permission Description
get_dau_data_series /kpi/dau/data_series read View KPI data Daily series of unique active users per date.
get_mau_data_series /kpi/mau/data_series read View KPI data Daily series of unique active users over a 30-day rolling window.
get_new_users_data_series /kpi/new_users/data_series read View KPI data Daily series of total new users per date.
get_uninstalls_data_series /kpi/uninstalls/data_series read View KPI data Daily series of total uninstalls per date.

Media library

Tool API endpoint Access Permission Description
create_media_library_asset /media_library/create create Manage media library assets Upload an asset to the Braze media library through external URL or base64 file content. Exactly one upload mode must be provided.

Purchases

Tool API endpoint Access Permission Description
get_product_list /purchases/product_list read View custom events, attributes, and purchases Paginated list of product IDs.
get_quantity_series /purchases/quantity_series read View custom events, attributes, and purchases Total number of purchases in your app over a time range.
get_revenue_series /purchases/revenue_series read View custom events, attributes, and purchases Total money spent in your app over a time range.

Segments

Tool API endpoint Access Permission Description
get_segment_list /segments/list read View segments Export segments with name, Segment API identifier, and analytics-tracking flag.
get_segment_details /segments/details read View segments Retrieve relevant information on a segment by segment_id.
get_segment_data_series /segments/data_series read View segments Daily series of a segment’s estimated size over time.
get_workspace_segments MCP only read View segments List the workspace’s active segments as summaries, up to 100 per call, with cursor-based pagination. Archived segments and suppression lists are left out.
get_segment_filters MCP only read View segments Discover the filters, comparisons, and value types that are valid in a segment filter tree.
create_segment MCP only create Create segments Create a user-defined segment from a filter tree.
edit_segment MCP only update Edit segments Edit an existing user-defined segment. Supplying an audience replaces its filter tree.
archive_segment MCP only update Archive segments Archive a segment and the segments, campaigns, and Canvases that depend on it. Call without cascade first to review dependents.
unarchive_segment MCP only update Archive segments Unarchive a segment. Dependents archived along with it stay archived.

The segment tools are generally available and don’t require you to join a beta program.

Tags

Tool API endpoint Access Permission Description
get_workspace_tags MCP only read View tags List every live tag in a workspace by full name, sorted by name, in one response with no pagination. A nested tag’s name is its full path, such as Seasonal/Spring.
create_workspace_tag MCP only create Edit tags Create a tag in a workspace, either top-level or nested under an existing tag, and return its full name. A name that only a deleted tag has restores that tag. If a live tag already has the name, in any letter case, the call fails with a 409 error and changes nothing.

The tag tools are generally available and don’t require you to join a beta program.

Brand guidelines

Tool API endpoint Access Permission Description
get_brand_guidelines MCP only read None List a workspace’s active brand guidelines, most recently updated first, without their guideline text, and mark which one is the default.
get_default_brand_guideline MCP only read None Get a workspace’s default brand guideline with its guideline text, in one call. If the workspace has no default, the call returns a DEFAULT_BRAND_GUIDELINE_NOT_SET error.
get_brand_guideline MCP only read None Get one brand guideline with its guideline text, including an archived one.

The brand guideline tools are generally available and don’t require you to join a beta program. These tools are read-only. To create or edit brand guidelines, use the Braze dashboard.

Sends

Tool API endpoint Access Permission Description
get_send_data_series /sends/data_series read View send data Daily stats for a tracked send_id (API campaigns). Braze stores send analytics for 14 days after the send.

Sessions

Tool API endpoint Access Permission Description
get_session_data_series /sessions/data_series read View session data Number of sessions for your app over a designated time period.

Templates

Tool API endpoint Access Permission Description
get_email_templates /templates/email/list read View email templates List available email templates in your Braze account.
get_email_template_info /templates/email/info read View email templates Get information for a specific email template. Drag-and-drop editor templates are not accepted.
create_email_template /templates/email/create create Manage email templates Create an email template on the Braze dashboard.
update_email_template /templates/email/update update Manage email templates Update an existing email template.

Content blocks

Tool API endpoint Access Permission Description
get_content_blocks /content_blocks/list read View content blocks List existing content block information.
get_content_block_info /content_blocks/info read View content blocks Get information for an existing content block, optionally with campaign or Canvas inclusion data.
create_content_block /content_blocks/create create Manage content blocks Create a content block.
update_content_block /content_blocks/update update Manage content blocks Update a content block.

Operator

Tool API endpoint Access Permission Description
send_operator_prompt MCP only update Use BrazeAI Operator Send a natural-language prompt to the BrazeAI Operator. Submits a background job and returns a job_id.
get_operator_result MCP only read Use BrazeAI Operator Poll for the result of a submitted Operator job using its job_id.
cancel_operator_job MCP only update Use BrazeAI Operator Cancel a running Operator job.

Skills

Tool API endpoint Access Permission Description
get_operator_skills MCP only read View Skills List the workspace’s skills, with each skill’s name and description.
get_operator_skill MCP only read View Skills Read a skill, including its instructions.
create_operator_skill MCP only create View Skills, Edit Skills Create a skill. If the name is already in use, Braze adds a suffix.
update_operator_skill MCP only update View Skills, Edit Skills Edit a skill. Fields you leave out keep their current values.

For more information, see Skills.

How instructions and responses are handled

The Braze MCP server receives instructions from your Third-Party Provider MCP client, such as Claude, ChatGPT, Copilot, Gemini CLI, Codex, or Cursor, exactly as that provider’s underlying AI model formulates them. When you type a request in natural language, the AI model interprets your request and translates it into one or more specific tool calls to Braze. Braze receives and executes the tool call as sent. Braze does not see your original natural-language prompt and cannot verify that the generated tool call fully or accurately reflects your intended request.

When Braze returns data or a result, that response is sent back to your Third-Party Provider MCP client, which then interprets, formats, and presents it to you. Braze does not control how the AI model presents, summarizes, or describes returned information.

Braze is not liable for instructions generated by, or responses conveyed through, any Third-Party Provider MCP client. Braze recommends not using “auto-mode” if your Third-Party Provider MCP client offers it for automatic action implementation. Review AI-generated summaries against source data in your Braze dashboard and review any AI-proposed action before implementing it through your Third-Party Provider MCP client.

New Stuff!