productivity
Braze MCP, CLI, and Lua Integration for AI Agents
Braze integration docs for AI agents: MCP gateway setup, Braze CLI commands, Lua API reference, credentials, and function schemas.Braze for agents
Credentials can be configured manually in web or CLI hosts.
Use this integration from Lua code mode, the headless integrations CLI, or the KosmoKrator MCP gateway. The same package metadata powers all three surfaces.
Agent Surfaces
Machine-Readable Metadata
Function Catalog
| Function | Type | Parameters | Description |
|---|---|---|---|
braze.braze_api_get | Read read | 0 | Call any Braze REST API GET endpoint with query parameters. |
braze.braze_api_post | Write write | 0 | Call any Braze REST API POST endpoint with a JSON payload. |
braze.braze_api_put | Write write | 0 | Call any Braze REST API PUT endpoint with a JSON payload. |
braze.braze_api_patch | Write write | 0 | Call any Braze REST API PATCH endpoint with a JSON payload. |
braze.braze_api_delete | Write write | 0 | Call any Braze REST API DELETE endpoint with query parameters. |
braze.braze_list_catalogs | Read read | 0 | List Braze catalogs. |
braze.braze_create_catalog | Write write | 0 | Create a Braze catalog. |
braze.braze_delete_catalog | Write write | 0 | Delete a Braze catalog. |
braze.braze_list_catalog_items | Read read | 0 | List items in a Braze catalog. |
braze.braze_get_catalog_item | Read read | 0 | Get a single Braze catalog item. |
braze.braze_create_catalog_item | Write write | 0 | Create a Braze catalog item. |
braze.braze_replace_catalog_item | Write write | 0 | Replace a Braze catalog item. |
braze.braze_edit_catalog_item | Write write | 0 | Edit a Braze catalog item. |
braze.braze_delete_catalog_item | Write write | 0 | Delete a Braze catalog item. |
braze.braze_create_catalog_items | Write write | 0 | Create multiple Braze catalog items asynchronously. |
braze.braze_replace_catalog_items | Write write | 0 | Replace multiple Braze catalog items asynchronously. |
braze.braze_edit_catalog_items | Write write | 0 | Edit multiple Braze catalog items asynchronously. |
braze.braze_delete_catalog_items | Write write | 0 | Delete multiple Braze catalog items asynchronously. |
braze.braze_create_catalog_fields | Write write | 0 | Create Braze catalog fields. |
braze.braze_delete_catalog_field | Write write | 0 | Delete a Braze catalog field. |
braze.braze_create_catalog_selection | Write write | 0 | Create a Braze catalog selection. |
braze.braze_delete_catalog_selection | Write write | 0 | Delete a Braze catalog selection. |
braze.braze_list_cdi_integrations | Read read | 0 | List Braze Cloud Data Ingestion integrations. |
braze.braze_get_cdi_sync_status | Read read | 0 | Get Cloud Data Ingestion sync status. |
braze.braze_trigger_cdi_sync | Write write | 0 | Trigger a Cloud Data Ingestion sync. |
braze.braze_list_hard_bounces | Read read | 0 | Query hard bounced email addresses. |
braze.braze_list_unsubscribes | Read read | 0 | Query unsubscribed email addresses. |
braze.braze_change_email_status | Write write | 0 | Change an email subscription status. |
braze.braze_remove_hard_bounces | Write write | 0 | Remove email addresses from the hard bounce list. |
braze.braze_remove_spam_emails | Write write | 0 | Remove email addresses from the spam list. |
braze.braze_blocklist_emails | Write write | 0 | Blocklist email addresses in Braze. |
braze.braze_list_campaigns | Read read | 0 | List Braze campaigns. |
braze.braze_get_campaign | Read read | 0 | Get Braze campaign details. |
braze.braze_get_campaign_analytics | Read read | 0 | Export campaign analytics over a time range. |
braze.braze_get_send_analytics | Read read | 0 | Export send analytics over a time range. |
braze.braze_get_campaign_url_info | Read read | 0 | Get URL details for a campaign message variation. |
braze.braze_duplicate_campaign | Write write | 0 | Duplicate a Braze campaign. |
braze.braze_list_canvases | Read read | 0 | List Braze Canvases. |
braze.braze_get_canvas | Read read | 0 | Get Braze Canvas details. |
braze.braze_get_canvas_analytics | Read read | 0 | Export Canvas analytics over a time range. |
braze.braze_get_canvas_summary | Read read | 0 | Export Canvas summary analytics. |
braze.braze_get_canvas_url_info | Read read | 0 | Get URL details for a Canvas step message variation. |
braze.braze_duplicate_canvas | Write write | 0 | Duplicate a Braze Canvas. |
braze.braze_list_events | Read read | 0 | List custom events. |
braze.braze_get_event_analytics | Read read | 0 | Export custom event analytics. |
braze.braze_list_custom_attributes | Read read | 0 | Export custom attributes. |
braze.braze_get_sessions_analytics | Read read | 0 | Export app sessions by time. |
braze.braze_get_daily_active_users | Read read | 0 | Export daily active users. |
braze.braze_get_monthly_active_users | Read read | 0 | Export monthly active users. |
braze.braze_get_new_users | Read read | 0 | Export daily new users. |
braze.braze_get_uninstalls | Read read | 0 | Export app uninstalls. |
braze.braze_list_products | Read read | 0 | Export product IDs purchased in the app. |
braze.braze_get_revenue_analytics | Read read | 0 | Export revenue data. |
braze.braze_get_purchase_quantity_analytics | Read read | 0 | Export number of purchases. |
braze.braze_list_segments | Read read | 0 | List Braze segments. |
braze.braze_get_segment | Read read | 0 | Get Braze segment details. |
braze.braze_get_segment_analytics | Read read | 0 | Export segment analytics. |
braze.braze_cancel_segment_export | Write write | 0 | Cancel user exports by segment. |
braze.braze_create_send_ids | Write write | 0 | Create send IDs for message blast tracking. |
braze.braze_send_messages | Write write | 0 | Send immediate API-only messages. |
braze.braze_send_transactional_email | Write write | 0 | Send a transactional email using API-triggered delivery. |
braze.braze_trigger_campaign_send | Write write | 0 | Trigger an API-triggered Braze campaign. |
braze.braze_trigger_canvas_send | Write write | 0 | Trigger an API-triggered Braze Canvas. |
braze.braze_list_scheduled_broadcasts | Read read | 0 | List upcoming scheduled campaigns and Canvases. |
braze.braze_create_scheduled_messages | Write write | 0 | Create scheduled messages. |
braze.braze_update_scheduled_messages | Write write | 0 | Update scheduled messages. |
braze.braze_delete_scheduled_messages | Write write | 0 | Delete scheduled messages. |
braze.braze_schedule_campaign_trigger | Write write | 0 | Schedule an API-triggered campaign. |
braze.braze_update_campaign_trigger_schedule | Write write | 0 | Update a scheduled API-triggered campaign. |
braze.braze_delete_campaign_trigger_schedule | Write write | 0 | Delete a scheduled API-triggered campaign. |
braze.braze_schedule_canvas_trigger | Write write | 0 | Schedule an API-triggered Canvas. |
braze.braze_update_canvas_trigger_schedule | Write write | 0 | Update a scheduled API-triggered Canvas. |
braze.braze_delete_canvas_trigger_schedule | Write write | 0 | Delete a scheduled API-triggered Canvas. |
braze.braze_start_live_activity | Write write | 0 | Start an iOS Live Activity. |
braze.braze_update_live_activity | Write write | 0 | Update an iOS Live Activity. |
braze.braze_list_preference_centers | Read read | 0 | List Braze preference centers. |
braze.braze_get_preference_center | Read read | 0 | Get a Braze preference center. |
braze.braze_generate_preference_center_url | Read read | 0 | Generate a preference center URL for a user. |
braze.braze_create_preference_center | Write write | 0 | Create a Braze preference center. |
braze.braze_update_preference_center | Write write | 0 | Update a Braze preference center. |
braze.braze_search_scim_users | Read read | 0 | Search Braze dashboard SCIM users. |
braze.braze_get_scim_user | Read read | 0 | Look up a Braze dashboard SCIM user. |
braze.braze_create_scim_user | Write write | 0 | Create a Braze dashboard SCIM user. |
braze.braze_update_scim_user | Write write | 0 | Update a Braze dashboard SCIM user. |
braze.braze_delete_scim_user | Write write | 0 | Remove a Braze dashboard SCIM user. |
braze.braze_create_sdk_authentication_key | Write write | 0 | Create an SDK authentication key. |
braze.braze_list_sdk_authentication_keys | Read read | 0 | List SDK authentication keys. |
braze.braze_set_primary_sdk_authentication_key | Write write | 0 | Set the primary SDK authentication key. |
braze.braze_delete_sdk_authentication_key | Write write | 0 | Delete an SDK authentication key. |
braze.braze_list_invalid_phone_numbers | Read read | 0 | Query invalid phone numbers. |
braze.braze_remove_invalid_phone_numbers | Write write | 0 | Remove invalid phone number flags. |
braze.braze_get_subscription_group_status | Read read | 0 | List users subscription group status. |
braze.braze_list_user_subscription_groups | Read read | 0 | List subscription groups for users. |
braze.braze_set_subscription_group_status | Write write | 0 | Update users subscription group status. |
braze.braze_set_subscription_group_status_v2 | Write write | 0 | Update users subscription group status using v2 semantics. |
braze.braze_list_content_blocks | Read read | 0 | List available content blocks. |
braze.braze_get_content_block | Read read | 0 | Get Content Block information. |
braze.braze_create_content_block | Write write | 0 | Create a Content Block. |
braze.braze_update_content_block | Write write | 0 | Update a Content Block. |
braze.braze_list_email_templates | Read read | 0 | List email templates. |
braze.braze_get_email_template | Read read | 0 | Get email template information. |
braze.braze_create_email_template | Write write | 0 | Create an email template. |
braze.braze_update_email_template | Write write | 0 | Update an email template. |
braze.braze_create_user_alias | Write write | 0 | Create a new user alias. |
braze.braze_update_user_alias | Write write | 0 | Update a user alias. |
braze.braze_identify_users | Write write | 0 | Identify alias-only users with external IDs. |
braze.braze_track_users | Write write | 0 | Create or update users, custom events, and purchases. |
braze.braze_track_users_bulk | Write write | 0 | Create or update users in bulk. |
braze.braze_track_users_sync | Write write | 0 | Synchronously create or update users. |
braze.braze_delete_users | Write write | 0 | Delete Braze users. |
braze.braze_merge_users | Write write | 0 | Merge Braze users. |
braze.braze_rename_external_id | Write write | 0 | Rename a user external ID. |
braze.braze_remove_external_id | Write write | 0 | Remove user external IDs. |
braze.braze_export_users_by_ids | Read read | 0 | Export user profiles by identifiers. |
braze.braze_export_users_by_segment | Read read | 0 | Export user profiles by segment. |
braze.braze_export_global_control_group_users | Read read | 0 | Export global control group users. |
braze.braze_upload_media_asset | Write write | 0 | Upload an asset to the Braze media library. |