Skip to main content

Python DSL for Amazon Connect contact flow generation

Project description

CxBlueprint

Programmatic Amazon Connect contact flow generation using Python. Allows for Ai models to generate contact flows based on human languages way easier than writing JSON as majority of the time it will fail to generate a valid contact flow from scratch.

Simple Example

from cxblueprint import Flow

flow = Flow.build("Burger Order")

welcome = flow.play_prompt("Welcome to Burger Palace!")
menu = flow.get_input("Press 1 for Classic Burger or 2 for Veggie Burger", timeout=10)
welcome.then(menu)

classic = flow.play_prompt("You selected Classic Burger. Your order is confirmed!")
veggie = flow.play_prompt("You selected Veggie Burger. Your order is confirmed!")
error_msg = flow.play_prompt("Invalid selection. Goodbye.")

disconnect = flow.disconnect()

# Chain menu options with error handling
menu.when("1", classic) \
    .when("2", veggie) \
    .otherwise(error_msg) \
    .on_error("InputTimeLimitExceeded", error_msg) \
    .on_error("NoMatchingCondition", error_msg) \
    .on_error("NoMatchingError", error_msg)

# Or without chaining:
# menu.when("1", classic)
# menu.when("2", veggie)
# menu.otherwise(error_msg)
# menu.on_error("InputTimeLimitExceeded", error_msg)
# menu.on_error("NoMatchingCondition", error_msg)
# menu.on_error("NoMatchingError", error_msg)

classic.then(disconnect)
veggie.then(disconnect)
error_msg.then(disconnect)

flow.compile_to_file("burger_order.json")

Terraform Template Example

Use placeholders for dynamic resource ARNs:

from cxblueprint import Flow

flow = Flow.build("Counter Flow")

welcome = flow.play_prompt("Thank you for calling!")
invoke_counter = flow.invoke_lambda(
    function_arn="${COUNTER_LAMBDA_ARN}",  # Resolved by Terraform
    timeout_seconds="8"
)
welcome.then(invoke_counter)

say_count = flow.play_prompt("You are caller number $.External.count")
invoke_counter.then(say_count)

disconnect = flow.disconnect()
say_count.then(disconnect)
invoke_counter.on_error("NoMatchingError", disconnect)

flow.compile_to_file("counter_flow.json")

Generated Flow Examples

Here's what the generated flows look like in the Amazon Connect console:

Example Generated Flow

Example Generated Flow 2

MCP Server (AI Integration)

CxBlueprint includes an MCP server that lets AI tools (Claude Desktop, Cursor, VS Code) build contact flows conversationally.

pip install cxblueprint[mcp]

Configure Claude Desktop (~/Library/Application Support/Claude/claude_desktop_config.json):

{
  "mcpServers": {
    "cxblueprint": {
      "command": "cxblueprint-mcp"
    }
  }
}

Then ask Claude: "Build me an IVR with a welcome message and 3 menu options for sales, support, and billing"

The AI reads the bundled documentation automatically and uses the compile_flow tool to generate valid Amazon Connect JSON.

Features

  • Fluent Python API for building flows
  • MCP server for AI-assisted flow generation
  • Naive block positioning for AWS Connect visual canvas
  • Automatic UUID generation for blocks
  • Error/Conditional handling support
  • Integration with AWS Lambda and lexv2 bots
  • Template placeholder support for Terraform/IaC
  • Decompile existing flows to Python
  • Majority of Amazon Connect block types supported
  • Shell scripts to download, validate, and test flows against Connect

Possible Future Uses/Ideas:

  • Compliance Checking, check flow structures for best practices, encryption, etc.
  • Optimization Suggestions, analyze flows for efficiency improvements.
  • Output to diagram formats for other visualization tools.
  • Template library of common flow patterns.

Installation

pip install cxblueprint

# With MCP server for AI integration
pip install cxblueprint[mcp]

Quick Start

# See Terraform example
cd terraform_example
python flow_generator.py

# Deploy with Terraform
cd terraform
terraform init
terraform apply

Project Structure

src/cxblueprint/
  __init__.py           # Package exports
  flow_builder.py       # Main builder API
  flow_analyzer.py      # Flow validation
  mcp_server.py         # MCP server for AI integration
  blocks/               # All Connect block types
examples/               # Sample flows
docs/                   # API reference & AI instructions

Documentation

Requirements

  • Python 3.11+
  • AWS credentials (for deployment)
  • Terraform (optional, for infrastructure)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

cxblueprint-0.1.0.post5.tar.gz (442.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

cxblueprint-0.1.0.post5-py3-none-any.whl (67.1 kB view details)

Uploaded Python 3

File details

Details for the file cxblueprint-0.1.0.post5.tar.gz.

File metadata

  • Download URL: cxblueprint-0.1.0.post5.tar.gz
  • Upload date:
  • Size: 442.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for cxblueprint-0.1.0.post5.tar.gz
Algorithm Hash digest
SHA256 49923a0b6c8ac707ba996e30287813477f80436d87432d11727033528091c127
MD5 6db27db67191de83a3005e8dc71fd470
BLAKE2b-256 fb00700cb538718231bb9bb597ab7bb3d765e4df45bc3c72a7567a848230cf89

See more details on using hashes here.

File details

Details for the file cxblueprint-0.1.0.post5-py3-none-any.whl.

File metadata

File hashes

Hashes for cxblueprint-0.1.0.post5-py3-none-any.whl
Algorithm Hash digest
SHA256 4b9e0403fde7079bea870bd71f40212dd7d9540fb44f59f6a8e4e917913153a7
MD5 8a9ba4fd5c94eff6cb0a5d19d1507f06
BLAKE2b-256 e839f5928d28191b795049f70c03d876b8678e795dd48d0548b36c328dd63ffe

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page