# How to integrate Userflow MCP with Autogen ```json { "title": "How to integrate Userflow MCP with Autogen", "toolkit": "Userflow", "toolkit_slug": "userflow", "framework": "AutoGen", "framework_slug": "autogen", "url": "https://composio.dev/toolkits/userflow/framework/autogen", "markdown_url": "https://composio.dev/toolkits/userflow/framework/autogen.md", "updated_at": "2026-03-29T06:54:25.318Z" } ``` ## Introduction This guide walks you through connecting Userflow to AutoGen using the Composio tool router. By the end, you'll have a working Userflow agent that can start a product tour for new users, add checklist item for onboarding task, update user segment to 'power users' through natural language commands. This guide will help you understand how to give your AutoGen agent real control over a Userflow account through Composio's Userflow MCP server. Before we dive in, let's take a quick look at the key ideas and tools involved. ## Also integrate Userflow with - [OpenAI Agents SDK](https://composio.dev/toolkits/userflow/framework/open-ai-agents-sdk) - [Claude Agent SDK](https://composio.dev/toolkits/userflow/framework/claude-agents-sdk) - [Claude Code](https://composio.dev/toolkits/userflow/framework/claude-code) - [Claude Cowork](https://composio.dev/toolkits/userflow/framework/claude-cowork) - [Codex](https://composio.dev/toolkits/userflow/framework/codex) - [OpenClaw](https://composio.dev/toolkits/userflow/framework/openclaw) - [Hermes](https://composio.dev/toolkits/userflow/framework/hermes-agent) - [CLI](https://composio.dev/toolkits/userflow/framework/cli) - [Google ADK](https://composio.dev/toolkits/userflow/framework/google-adk) - [LangChain](https://composio.dev/toolkits/userflow/framework/langchain) - [Vercel AI SDK](https://composio.dev/toolkits/userflow/framework/ai-sdk) - [Mastra AI](https://composio.dev/toolkits/userflow/framework/mastra-ai) - [LlamaIndex](https://composio.dev/toolkits/userflow/framework/llama-index) - [CrewAI](https://composio.dev/toolkits/userflow/framework/crew-ai) ## TL;DR Here's what you'll learn: - Get and set up your OpenAI and Composio API keys - Install the required dependencies for Autogen and Composio - Initialize Composio and create a Tool Router session for Userflow - Wire that MCP URL into Autogen using McpWorkbench and StreamableHttpServerParams - Configure an Autogen AssistantAgent that can call Userflow tools - Run a live chat loop where you ask the agent to perform Userflow operations ## What is AutoGen? Autogen is a framework for building multi-agent conversational AI systems from Microsoft. It enables you to create agents that can collaborate, use tools, and maintain complex workflows. Key features include: - Multi-Agent Systems: Build collaborative agent workflows - MCP Workbench: Native support for Model Context Protocol tools - Streaming HTTP: Connect to external services through streamable HTTP - AssistantAgent: Pre-built agent class for tool-using assistants ## What is the Userflow MCP server, and what's possible with it? The Userflow MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Userflow account. It provides structured and secure access so your agent can perform Userflow operations on your behalf. ## Supported Tools | Tool slug | Name | Description | |---|---|---| | `USERFLOW_CREATE_OR_UPDATE_A_GROUP` | Create or Update a Group | Tool to create a new group or update an existing group (also referred to as companies in the Userflow UI). Use when you need to create a new group or update attributes of an existing group by providing the group ID. | | `USERFLOW_CREATE_OR_UPDATE_A_USER` | Create or Update a User | Tool to create a new user or update an existing user in Userflow. Use when you need to synchronize user data from your back-end to Userflow. If the user ID exists, attributes will be merged; otherwise a new user is created. | | `USERFLOW_DELETE_A_CONTENT_SESSION` | Delete a Content Session | Tool to permanently delete a content session including its associated progress and survey answers. Use when you need to remove a content session from the system. This action cannot be undone. This operation is idempotent and will succeed even if the content session already doesn't exist. | | `USERFLOW_DELETE_A_GROUP` | Delete a Group | Tool to permanently delete a group including all their attributes, memberships and events. Use when you need to remove a group from the system. This action cannot be undone, but users who were members of the group will remain intact. This operation is idempotent and will succeed even if the group already doesn't exist. | | `USERFLOW_DELETE_A_USER` | Delete a User | Tool to permanently delete a user including all their attributes, memberships, events and flow history. Use when you need to remove a user from the system. This action cannot be undone, but groups that the user was a member of will remain intact. This operation is idempotent and will succeed even if the user already doesn't exist. | | `USERFLOW_GET_A_CONTENT_OBJECT` | Get a Content Object | Tool to retrieve details of a specific content object (flow, checklist, or launcher) by ID. Use when you need to get information about a single content object, including its draft and published versions. | | `USERFLOW_GET_A_CONTENT_VERSION` | Get a Content Version | Tool to retrieve details of a specific content version by ID. Use when you need to get information about a versioned content object, including its questions (for surveys) or tasks (for checklists). | | `USERFLOW_GET_A_GROUP` | Get a Group | Tool to retrieve details of a specific group (company) by group_id. Use when you need to get information about a group including their attributes, creation timestamp, and optionally expanded relationships like memberships and users. Note: Groups are called 'Companies' in the Userflow UI, but the API uses 'groups' terminology. | | `USERFLOW_GET_A_USER` | Get a User | Tool to retrieve details of a specific user by user_id. Use when you need to get information about a user including their attributes, creation timestamp, and optionally expanded relationships like memberships and groups. | | `USERFLOW_LIST_ATTRIBUTE_DEFINITIONS` | List Attribute Definitions | Tool to retrieve all attribute definitions for users and groups tracked by Userflow. Use when you need to see what attributes are being tracked. Attribute definitions are automatically created when new attributes are sent. | | `USERFLOW_LIST_CONTENT` | List Content | Tool to retrieve all content (flows, checklists, and launchers) in your Userflow account. Use when you need to check what content is available for users to start in your application. | | `USERFLOW_LIST_CONTENT_SESSIONS` | List Content Sessions | Tool to retrieve all content sessions tracking user interactions with content. Use when you need to see user journeys through flows, checklists, or launchers, including their progress and survey answers. | | `USERFLOW_LIST_CONTENT_VERSIONS` | List Content Versions | Tool to retrieve all versions of content including survey questions and checklist tasks. Use when you need to see the version history of flows, checklists, or launchers to track changes over time. | | `USERFLOW_LIST_EVENT_DEFINITIONS` | List Event Definitions | Tool to retrieve all event definitions tracked in Userflow. Use when you need to see what events are being tracked. Event definitions are automatically created when new events are tracked. | | `USERFLOW_LIST_GROUPS` | List Groups | Tool to retrieve all groups (companies) in your Userflow account with pagination and filtering support. Use when you need to list groups or search for specific groups based on attributes. Note: Groups are called 'Companies' in the Userflow UI. | | `USERFLOW_LIST_USERS` | List Users | Tool to retrieve a paginated list of all users. Use when you need to list users with optional filtering, sorting, and expansion of related objects like memberships and groups. | | `USERFLOW_REMOVE_A_USER_FROM_A_GROUP` | Remove a User from a Group | Tool to remove a user from a group (group membership). Use when you need to revoke a user's membership in a specific group. This operation is idempotent and will succeed even if the user is not already a member of the group. | | `USERFLOW_TRACK_AN_EVENT` | Track an Event | Tool to record a custom event for a user or group for analytics and personalization. Use when you need to track user actions or behaviors. Events can be associated with just a user, just a group, or both a user and a group. | ## Supported Triggers None listed. ## Creating MCP Server - Stand-alone vs Composio SDK The Userflow MCP server is an implementation of the Model Context Protocol that connects your AI agents and assistants directly to Userflow. Instead of manually wiring Userflow APIs, OAuth, and scopes yourself, you get a structured, tool-based interface that an LLM can call safely. With Composio's managed implementation, you don't have to create your own developer app. For production, if you're building an end product, we recommend using your own credentials. The managed server helps you prototype fast and go from 0-1 faster. ## Step-by-step Guide ### 1. Prerequisites You will need: - A Composio API key - An OpenAI API key (used by Autogen's OpenAIChatCompletionClient) - A Userflow account you can connect to Composio - Some basic familiarity with Autogen and Python async ### 1. Getting API Keys for OpenAI and Composio OpenAI API Key - Go to the [OpenAI dashboard](https://platform.openai.com/settings/organization/api-keys) and create an API key. You'll need credits to use the models, or you can connect to another model provider. - Keep the API key safe. Composio API Key - Log in to the [Composio dashboard](https://dashboard.composio.dev?utm_source=toolkits&utm_medium=framework_docs). - Navigate to your API settings and generate a new API key. - Store this key securely as you'll need it for authentication. ### 2. Install dependencies Install Composio, Autogen extensions, and dotenv. What's happening: - composio connects your agent to Userflow via MCP - autogen-agentchat provides the AssistantAgent class - autogen-ext-openai provides the OpenAI model client - autogen-ext-tools provides MCP workbench support ```bash pip install composio python-dotenv pip install autogen-agentchat autogen-ext-openai autogen-ext-tools ``` ### 3. Set up environment variables Create a .env file in your project folder. What's happening: - COMPOSIO_API_KEY is required to talk to Composio - OPENAI_API_KEY is used by Autogen's OpenAI client - USER_ID is how Composio identifies which user's Userflow connections to use ```bash COMPOSIO_API_KEY=your-composio-api-key OPENAI_API_KEY=your-openai-api-key USER_ID=your-user-identifier@example.com ``` ### 4. Import dependencies and create Tool Router session What's happening: - load_dotenv() reads your .env file - Composio(api_key=...) initializes the SDK - create(...) creates a Tool Router session that exposes Userflow tools - session.mcp.url is the MCP endpoint that Autogen will connect to ```python import asyncio import os from dotenv import load_dotenv from composio import Composio from autogen_agentchat.agents import AssistantAgent from autogen_ext.models.openai import OpenAIChatCompletionClient from autogen_ext.tools.mcp import McpWorkbench, StreamableHttpServerParams load_dotenv() async def main(): # Initialize Composio and create a Userflow session composio = Composio(api_key=os.getenv("COMPOSIO_API_KEY")) session = composio.create( user_id=os.getenv("USER_ID"), toolkits=["userflow"] ) url = session.mcp.url ``` ### 5. Configure MCP parameters for Autogen Autogen expects parameters describing how to talk to the MCP server. That is what StreamableHttpServerParams is for. What's happening: - url points to the Tool Router MCP endpoint from Composio - timeout is the HTTP timeout for requests - sse_read_timeout controls how long to wait when streaming responses - terminate_on_close=True cleans up the MCP server process when the workbench is closed ```python # Configure MCP server parameters for Streamable HTTP server_params = StreamableHttpServerParams( url=url, timeout=30.0, sse_read_timeout=300.0, terminate_on_close=True, headers={"x-api-key": os.getenv("COMPOSIO_API_KEY")} ) ``` ### 6. Create the model client and agent What's happening: - OpenAIChatCompletionClient wraps the OpenAI model for Autogen - McpWorkbench connects the agent to the MCP tools - AssistantAgent is configured with the Userflow tools from the workbench ```python # Create model client model_client = OpenAIChatCompletionClient( model="gpt-5", api_key=os.getenv("OPENAI_API_KEY") ) # Use McpWorkbench as context manager async with McpWorkbench(server_params) as workbench: # Create Userflow assistant agent with MCP tools agent = AssistantAgent( name="userflow_assistant", description="An AI assistant that helps with Userflow operations.", model_client=model_client, workbench=workbench, model_client_stream=True, max_tool_iterations=10 ) ``` ### 7. Run the interactive chat loop What's happening: - The script prompts you in a loop with You: - Autogen passes your input to the model, which decides which Userflow tools to call via MCP - agent.run_stream(...) yields streaming messages as the agent thinks and calls tools - Typing exit, quit, or bye ends the loop ```python print("Chat started! Type 'exit' or 'quit' to end the conversation.\n") print("Ask any Userflow related question or task to the agent.\n") # Conversation loop while True: user_input = input("You: ").strip() if user_input.lower() in ["exit", "quit", "bye"]: print("\nGoodbye!") break if not user_input: continue print("\nAgent is thinking...\n") # Run the agent with streaming try: response_text = "" async for message in agent.run_stream(task=user_input): if hasattr(message, "content") and message.content: response_text = message.content # Print the final response if response_text: print(f"Agent: {response_text}\n") else: print("Agent: I encountered an issue processing your request.\n") except Exception as e: print(f"Agent: Sorry, I encountered an error: {str(e)}\n") ``` ## Complete Code ```python import asyncio import os from dotenv import load_dotenv from composio import Composio from autogen_agentchat.agents import AssistantAgent from autogen_ext.models.openai import OpenAIChatCompletionClient from autogen_ext.tools.mcp import McpWorkbench, StreamableHttpServerParams load_dotenv() async def main(): # Initialize Composio and create a Userflow session composio = Composio(api_key=os.getenv("COMPOSIO_API_KEY")) session = composio.create( user_id=os.getenv("USER_ID"), toolkits=["userflow"] ) url = session.mcp.url # Configure MCP server parameters for Streamable HTTP server_params = StreamableHttpServerParams( url=url, timeout=30.0, sse_read_timeout=300.0, terminate_on_close=True, headers={"x-api-key": os.getenv("COMPOSIO_API_KEY")} ) # Create model client model_client = OpenAIChatCompletionClient( model="gpt-5", api_key=os.getenv("OPENAI_API_KEY") ) # Use McpWorkbench as context manager async with McpWorkbench(server_params) as workbench: # Create Userflow assistant agent with MCP tools agent = AssistantAgent( name="userflow_assistant", description="An AI assistant that helps with Userflow operations.", model_client=model_client, workbench=workbench, model_client_stream=True, max_tool_iterations=10 ) print("Chat started! Type 'exit' or 'quit' to end the conversation.\n") print("Ask any Userflow related question or task to the agent.\n") # Conversation loop while True: user_input = input("You: ").strip() if user_input.lower() in ['exit', 'quit', 'bye']: print("\nGoodbye!") break if not user_input: continue print("\nAgent is thinking...\n") # Run the agent with streaming try: response_text = "" async for message in agent.run_stream(task=user_input): if hasattr(message, 'content') and message.content: response_text = message.content # Print the final response if response_text: print(f"Agent: {response_text}\n") else: print("Agent: I encountered an issue processing your request.\n") except Exception as e: print(f"Agent: Sorry, I encountered an error: {str(e)}\n") if __name__ == "__main__": asyncio.run(main()) ``` ## Conclusion You now have an Autogen assistant wired into Userflow through Composio's Tool Router and MCP. From here you can: - Add more toolkits to the toolkits list, for example notion or hubspot - Refine the agent description to point it at specific workflows - Wrap this script behind a UI, Slack bot, or internal tool Once the pattern is clear for Userflow, you can reuse the same structure for other MCP-enabled apps with minimal code changes. ## How to build Userflow MCP Agent with another framework - [OpenAI Agents SDK](https://composio.dev/toolkits/userflow/framework/open-ai-agents-sdk) - [Claude Agent SDK](https://composio.dev/toolkits/userflow/framework/claude-agents-sdk) - [Claude Code](https://composio.dev/toolkits/userflow/framework/claude-code) - [Claude Cowork](https://composio.dev/toolkits/userflow/framework/claude-cowork) - [Codex](https://composio.dev/toolkits/userflow/framework/codex) - [OpenClaw](https://composio.dev/toolkits/userflow/framework/openclaw) - [Hermes](https://composio.dev/toolkits/userflow/framework/hermes-agent) - [CLI](https://composio.dev/toolkits/userflow/framework/cli) - [Google ADK](https://composio.dev/toolkits/userflow/framework/google-adk) - [LangChain](https://composio.dev/toolkits/userflow/framework/langchain) - [Vercel AI SDK](https://composio.dev/toolkits/userflow/framework/ai-sdk) - [Mastra AI](https://composio.dev/toolkits/userflow/framework/mastra-ai) - [LlamaIndex](https://composio.dev/toolkits/userflow/framework/llama-index) - [CrewAI](https://composio.dev/toolkits/userflow/framework/crew-ai) ## Related Toolkits - [Google Sheets](https://composio.dev/toolkits/googlesheets) - Google Sheets is a cloud-based spreadsheet tool for real-time collaboration and data analysis. It lets teams work together from anywhere, updating information instantly. - [Notion](https://composio.dev/toolkits/notion) - Notion is a collaborative workspace for notes, docs, wikis, and tasks. It streamlines team knowledge, project tracking, and workflow customization in one place. - [Airtable](https://composio.dev/toolkits/airtable) - Airtable combines the flexibility of spreadsheets with the power of a database for easy project and data management. Teams use Airtable to organize, track, and collaborate with custom views and automations. - [Asana](https://composio.dev/toolkits/asana) - Asana is a collaborative work management platform for teams to organize and track projects. It streamlines teamwork, boosts productivity, and keeps everyone aligned on goals. - [Google Tasks](https://composio.dev/toolkits/googletasks) - Google Tasks is a to-do list and task management tool integrated into Gmail and Google Calendar. It helps you organize, track, and complete tasks across your Google ecosystem. - [Linear](https://composio.dev/toolkits/linear) - Linear is a modern issue tracking and project planning tool for fast-moving teams. It helps streamline workflows, organize projects, and boost productivity. - [Jira](https://composio.dev/toolkits/jira) - Jira is Atlassian’s platform for bug tracking, issue tracking, and agile project management. It helps teams organize work, prioritize tasks, and deliver projects efficiently. - [Clickup](https://composio.dev/toolkits/clickup) - ClickUp is an all-in-one productivity platform for managing tasks, docs, goals, and team collaboration. It streamlines project workflows so teams can work smarter and stay organized in one place. - [Monday](https://composio.dev/toolkits/monday) - Monday.com is a customizable work management platform for project planning and collaboration. It helps teams organize tasks, automate workflows, and track progress in real time. - [Addressfinder](https://composio.dev/toolkits/addressfinder) - Addressfinder is a data quality platform for verifying addresses, emails, and phone numbers. It helps you ensure accurate customer and contact data every time. - [Agiled](https://composio.dev/toolkits/agiled) - Agiled is an all-in-one business management platform for CRM, projects, and finance. It helps you streamline workflows, consolidate client data, and manage business processes in one place. - [Ascora](https://composio.dev/toolkits/ascora) - Ascora is a cloud-based field service management platform for service businesses. It streamlines scheduling, invoicing, and customer operations in one place. - [Basecamp](https://composio.dev/toolkits/basecamp) - Basecamp is a project management and team collaboration tool by 37signals. It helps teams organize tasks, share files, and communicate efficiently in one place. - [Beeminder](https://composio.dev/toolkits/beeminder) - Beeminder is an online goal-tracking platform that uses monetary pledges to keep you motivated. Stay accountable and hit your targets with real financial incentives. - [Boxhero](https://composio.dev/toolkits/boxhero) - Boxhero is a cloud-based inventory management platform for SMBs, offering real-time updates, barcode scanning, and team collaboration. It helps businesses streamline stock tracking and analytics for smarter inventory decisions. - [Breathe HR](https://composio.dev/toolkits/breathehr) - Breathe HR is cloud-based HR software for SMEs to manage employee data, absences, and performance. It simplifies HR admin, making it easy to keep employee records accurate and up to date. - [Breeze](https://composio.dev/toolkits/breeze) - Breeze is a project management platform designed to help teams plan, track, and collaborate on projects. It streamlines workflows and keeps everyone on the same page. - [Bugherd](https://composio.dev/toolkits/bugherd) - Bugherd is a visual feedback and bug tracking tool for websites. It helps teams and clients report website issues directly on live sites for faster fixes. - [Canny](https://composio.dev/toolkits/canny) - Canny is a platform for managing customer feedback and feature requests. It helps teams prioritize product decisions based on real user insights. - [Chmeetings](https://composio.dev/toolkits/chmeetings) - Chmeetings is a church management platform for events, members, donations, and volunteers. It streamlines church operations and improves community engagement. ## Frequently Asked Questions ### What are the differences in Tool Router MCP and Userflow MCP? With a standalone Userflow MCP server, the agents and LLMs can only access a fixed set of Userflow tools tied to that server. However, with the Composio Tool Router, agents can dynamically load tools from Userflow and many other apps based on the task at hand, all through a single MCP endpoint. ### Can I use Tool Router MCP with Autogen? Yes, you can. Autogen fully supports MCP integration. You get structured tool calling, message history handling, and model orchestration while Tool Router takes care of discovering and serving the right Userflow tools. ### Can I manage the permissions and scopes for Userflow while using Tool Router? Yes, absolutely. You can configure which Userflow scopes and actions are allowed when connecting your account to Composio. You can also bring your own OAuth credentials or API configuration so you keep full control over what the agent can do. ### How safe is my data with Composio Tool Router? All sensitive data such as tokens, keys, and configuration is fully encrypted at rest and in transit. Composio is SOC 2 Type 2 compliant and follows strict security practices so your Userflow data and credentials are handled as safely as possible. --- [See all toolkits](https://composio.dev/toolkits) · [Composio docs](https://docs.composio.dev/llms.txt)