Skip to main content

Python DSL for Amazon Connect contact flow generation

Project description

CxBlueprint

CI PyPI Python

Programmatic Amazon Connect contact flow generation using Python. Lets AI models and developers build contact flows from plain English instead of hand-writing JSON.

47 of 56 AWS Connect block types supported (84%) — covers all common IVR, routing, A/B testing, queue transfer, customer profiles, case management, and Voice ID patterns. Includes an MCP server for AI-assisted flow generation with Claude Desktop, Cursor, and VS Code.

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()

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)

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

Installation

pip install cxblueprint

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

MCP Server

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

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.

Block Coverage

47 / 56 block types implemented (84%)

Category Implemented Total Coverage
Participant Actions 6 6 100%
Contact Actions 24 27 89%
Flow Control Actions 11 15 73%
Interactions 6 8 75%

See each category's README for the full per-block breakdown.

Features

  • Fluent Python API for building flows
  • MCP server for AI-assisted flow generation
  • Canvas layout positioning for AWS Connect visual editor
  • Automatic UUID generation for blocks
  • Conditional branching and error handling
  • AWS Lambda and Lex V2 bot integration
  • Template placeholder support for Terraform/IaC
  • Decompile existing flows back to Python

Project Structure

src/cxblueprint/
  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.post10.tar.gz (496.5 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.post10-py3-none-any.whl (98.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cxblueprint-0.1.0.post10.tar.gz
  • Upload date:
  • Size: 496.5 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.post10.tar.gz
Algorithm Hash digest
SHA256 ec4ea811e6fbc91c0ac56aa56f8a920dcd0339e9e4133ea9ab96b9b301d70c7f
MD5 fe7e16ceda8ee7d20696663dc38fbe3c
BLAKE2b-256 82c7ce0a8b0984ae0cca762f478382c3512e30eeebeb1be3a798a534976d3548

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for cxblueprint-0.1.0.post10-py3-none-any.whl
Algorithm Hash digest
SHA256 dae22cae3f50f02fe665d3b977ce35e4bef5c3632acf04f53bc868d8d52a6f48
MD5 560ccac3b19e57cba8a1bf0dadcfea1d
BLAKE2b-256 cf8926b51ebf3376bca58583a75d9d9a10824e73400e7a02f649bfdb3024cc2d

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