braze-mcp-server 1.0.4

Braze MCP Server - Model Context Protocol server for Braze REST API Read-Only access

Braze MCP Server

Braze Model Context Protocol (MCP) server is a secure, read-only connection that lets AI tools like Claude and Cursor access non-PII Braze data to answer questions, analyze trends, and provide insights without altering data. For more general information, see Braze MCP server.

Additional resources

• Setting up Braze MCP server: A more-detailed alternative to the following Quick start section (includes troubleshooting).
• Using Braze MCP server: Best practices and usage examples for tools like Claude and Cursor.
• Available API functions: List of functions LLMs can use retrieve data from Braze.

Quick start

Step 1: Create an API key

In Braze, go to Settings > APIs and Identifiers > API Keys and create a new key with some or all the following permissions.

Category	Endpoint	Required Permission
Campaigns	/campaigns/data_series	campaigns.data_series
Campaigns	/campaigns/details	campaigns.details
Campaigns	/campaigns/list	campaigns.list
Campaigns	/sends/data_series	sends.data_series
Canvas	/canvas/data_series	canvas.data_series
Canvas	/canvas/data_summary	canvas.data_summary
Canvas	/canvas/details	canvas.details
Canvas	/canvas/list	canvas.list
Catalogs	/catalogs	catalogs.get
Catalogs	/catalogs/{catalog_name}/items	catalogs.get_items
Catalogs	/catalogs/{catalog_name}/items/{item_id}	catalogs.get_item
Cloud Data Ingestion	/cdi/integrations	cdi.integration_list
Cloud Data Ingestion	/cdi/integrations/{integration_id}/job_sync_status	cdi.integration_job_status
Content Blocks	/content_blocks/list	content_blocks.list
Content Blocks	/content_blocks/info	content_blocks.info
Custom Attributes	/custom_attributes	custom_attributes.get
Events	/events/list	events.list
Events	/events/data_series	events.data_series
Events	/events	events.get
KPIs	/kpi/new_users/data_series	kpi.new_users.data_series
KPIs	/kpi/dau/data_series	kpi.dau.data_series
KPIs	/kpi/mau/data_series	kpi.mau.data_series
KPIs	/kpi/uninstalls/data_series	kpi.uninstalls.data_series
Messages	/messages/scheduled_broadcasts	messages.schedule_broadcasts
Preference Center	/preference_center/v1/list	preference_center.list
Preference Center	/preference_center/v1/{preferenceCenterExternalID}	preference_center.get
Purchases	/purchases/product_list	purchases.product_list
Purchases	/purchases/revenue_series	purchases.revenue_series
Purchases	/purchases/quantity_series	purchases.quantity_series
Segments	/segments/list	segments.list
Segments	/segments/data_series	segments.data_series
Segments	/segments/details	segments.details
Sends	/sends/data_series	sends.data_series
Sessions	/sessions/data_series	sessions.data_series
SDK Authentication Keys	/app_group/sdk_authentication/keys	sdk_authentication.keys
Subscription	/subscription/status/get	subscription.status.get
Subscription	/subscription/user/status	subscription.groups.get
Templates	/templates/email/list	templates.email.list
Templates	/templates/email/info	templates.email.info

[!WARNING] Do not reuse an existing API key—create one specifically for your MCP client. Additionally, only assign read-only, non-PII permissions, as agents may try to write or delete data in Braze.

Step 2: Install uv

Run the following command to install uv, a command-line tool by Astral for dependency management and Python package handling:

MacOS and Linux

curl -LsSf https://astral.sh/uv/install.sh | sh

Windows

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

Step 3: Configure your MCP client

Configure your MCP client using our pre-provided configuration file.

Claude

1. In Claude Desktop, go to Settings > Developer > Edit Config, then add the following snippet:

   {
     "mcpServers": {
       "braze": {
         "command": "uvx",
         "args": ["--native-tls", "braze-mcp-server@latest"],
         "env": {
           "BRAZE_API_KEY": "your-braze-api-key",
           "BRAZE_BASE_URL": "your-braze-endpoint-url"
         }
       }
     }
   }
   

2. Save the configuration and restart Claude Desktop.
3. To verify your connection, try asking a question like "List my Braze campaigns".

Cursor

1. In Cursor, go to Settings > Tools and Integrations > MCP Tools > Add Custom MCP, then add the following snippet:

   {
     "mcpServers": {
       "braze": {
         "command": "uvx",
         "args": ["--native-tls", "braze-mcp-server@latest"],
         "env": {
           "BRAZE_API_KEY": "your-braze-api-key",
           "BRAZE_BASE_URL": "your-braze-endpoint-url"
         }
       }
     }
   }
   

2. When you're finished, save the configuration and restart Cursor.
3. To verify your connection, try using the provided MCP tools to interact with your Braze data.

Release flow

• Bump version in pyproject.toml
• Tag (e.g., v1.0.4) and push the tag
• Create a GitHub Release to trigger publish to PyPI

Disclaimer

The Model Context Protocol (MCP) is a newly introduced open-source protocol that may be susceptible to security issues or vulnerabilities at this time.

Braze MCP Server setup code and instructions are provided by Braze “as is” and without any warranties, and customers use it at their own risk. Braze shall not be responsible for any consequences arising from improper setup, misuse of the MCP, or any potential security issues that may arise. Braze strongly encourages customers to review their configurations carefully and to follow the outlined guidelines to reduce risks associated with the integrity and security of their Braze environment.

For assistance or clarification, please contact [e-mail].