What is Mcp Braze

mcp-braze is a Python server designed for seamless interaction with the Braze API, enabling users to manage catalogs, emails, segments, and more through a straightforward interface.

Use cases

Use cases for mcp-braze include managing product catalogs for e-commerce, updating email subscription statuses for marketing campaigns, querying email bounce data for analytics, and managing user segments for targeted messaging.

How to use

To use mcp-braze, install it via pip with ‘pip install mcp-braze’. Configure your Braze API credentials in a JSON format, including your API token and base URL. Utilize the provided examples to manage catalogs, emails, and segments effectively.

Key features

Key features of mcp-braze include authentication management, catalog management (creating and listing catalogs, adding items), email management (querying bounced emails, updating subscription statuses), and segment management (listing segments and retrieving detailed information).

Where to use

mcp-braze can be utilized in marketing automation, customer engagement, and data management sectors where interaction with the Braze API is required for managing user data and communication.

MCP Braze Integration

A Model context Protocol (MCP) integration for Braze’s REST API, allowing you to manage catalogs, emails, segments, and more through a simple interface.

Features

• Authentication Management

  • Configure Braze API token and base URL
  • Automatic authentication for all API operations

• Catalog Management

  • Create and list catalogs
  • Add and list catalog items
  • Support for item attributes and metadata

• Email Management

  • Query hard bounced and unsubscribed emails
  • Update email subscription status
  • Manage spam and blocklist entries
  • Support for subscription groups

• Segment Management

  • List all segments with pagination
  • Get detailed segment information
  • Support for analytics tracking

Installation

pip install mcp-braze

Configuration

Before using the integration, configure your Braze API credentials:

{
    "api_token": "your-braze-api-token",
    "base_url": "https://rest.iad-01.braze.com"  # Optional, defaults to US-01 instance
}

Usage Examples

Managing Catalogs

# Create a catalog
{
    "name": "products",
    "description": "Our product catalog"
}

# Add items to catalog
{
    "catalog_name": "products",
    "item_id": "prod-123",
    "name": "Sample Product",
    "description": "A great product",
    "attributes": {
        "price": 99.99,
        "category": "electronics"
    }
}

Managing Emails

# Update email subscription
{
    "email": "[email protected]",
    "status": "subscribed",
    "subscription_group_id": "group-123"  # optional
}

# Query bounced emails
{
    "start_date": "2024-01-01",
    "end_date": "2024-03-20",
    "limit": 100,
    "offset": 0
}

Managing Segments

# List segments
{
    "page": 0,
    "sort_direction": "desc"
}

# Get segment details
{
    "segment_id": "your-segment-id"
}

Development

1. Clone the repository:

git clone https://github.com/TMEFRT/mcp-braze.git
cd mcp-braze

2. Install dependencies:

pip install -r requirements.txt

3. Run tests:

pytest

Contributing

1. Fork the repository
2. Create your feature branch (git checkout -b feature/amazing-feature)
3. Commit your changes (git commit -m 'Add some amazing feature')
4. Push to the branch (git push origin feature/amazing-feature)
5. Open a Pull Request

License

This project is licensed under the MIT License - see the LICENSE file for details.