How to integrate Userflow MCP with Pydantic AI

This guide walks you through connecting Userflow to Pydantic AI 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 Pydantic AI 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.

Get started for freeGet a demo
Userflow logoUserflow
Api Key

Userflow is user onboarding software for building product tours and checklists. It helps teams guide users and drive product adoption without coding.

18 Tools

Introduction

This guide walks you through connecting Userflow to Pydantic AI 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 Pydantic AI 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 SDKClaude Agent SDKClaude CodeClaude CoworkCodexOpenClawHermesCLIGoogle ADKLangChainVercel AI SDKMastra AILlamaIndexCrewAI

TL;DR

Here's what you'll learn:
  • How to set up your Composio API key and User ID
  • How to create a Composio Tool Router session for Userflow
  • How to attach an MCP Server to a Pydantic AI agent
  • How to stream responses and maintain chat history
  • How to build a simple REPL-style chat interface to test your Userflow workflows

What is Pydantic AI?

Pydantic AI is a Python framework for building AI agents with strong typing and validation. It leverages Pydantic's data validation capabilities to create robust, type-safe AI applications.

Key features include:

  • Type Safety: Built on Pydantic for automatic data validation
  • MCP Support: Native support for Model Context Protocol servers
  • Streaming: Built-in support for streaming responses
  • Async First: Designed for async/await patterns

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.

What is the Composio tool router, and how does it fit here?

What is Composio SDK?

Composio's Composio SDK helps agents find the right tools for a task at runtime. You can plug in multiple toolkits (like Gmail, HubSpot, and GitHub), and the agent will identify the relevant app and action to complete multi-step workflows. This can reduce token usage and improve the reliability of tool calls. Read more here: Getting started with Composio SDK

The tool router generates a secure MCP URL that your agents can access to perform actions.

How the Composio SDK works

The Composio SDK follows a three-phase workflow:

  1. Discovery: Searches for tools matching your task and returns relevant toolkits with their details.
  2. Authentication: Checks for active connections. If missing, creates an auth config and returns a connection URL via Auth Link.
  3. Execution: Executes the action using the authenticated connection.

Step-by-step Guide

Step by step09 STEPS
1

Prerequisites

Before starting, make sure you have:
  • Python 3.9 or higher
  • A Composio account with an active API key
  • Basic familiarity with Python and async programming
2

Getting API Keys for OpenAI and Composio

OpenAI API Key
  • Go to the OpenAI dashboard 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.
  • Navigate to your API settings and generate a new API key.
  • Store this key securely as you'll need it for authentication.
3

Install dependencies

bash
pip install composio pydantic-ai python-dotenv

Install the required libraries.

What's happening:

  • composio connects your agent to external SaaS tools like Userflow
  • pydantic-ai lets you create structured AI agents with tool support
  • python-dotenv loads your environment variables securely from a .env file
4

Set up environment variables

bash
COMPOSIO_API_KEY=your_composio_api_key_here
USER_ID=your_user_id_here
OPENAI_API_KEY=your_openai_api_key

Create a .env file in your project root.

What's happening:

  • COMPOSIO_API_KEY authenticates your agent to Composio's API
  • USER_ID associates your session with your account for secure tool access
  • OPENAI_API_KEY to access OpenAI LLMs
5

Import dependencies

python
import asyncio
import os
from dotenv import load_dotenv
from composio import Composio
from pydantic_ai import Agent
from pydantic_ai.mcp import MCPServerStreamableHTTP

load_dotenv()
What's happening:
  • We load environment variables and import required modules
  • Composio manages connections to Userflow
  • MCPServerStreamableHTTP connects to the Userflow MCP server endpoint
  • Agent from Pydantic AI lets you define and run the AI assistant
6

Create a Tool Router Session

python
async def main():
    api_key = os.getenv("COMPOSIO_API_KEY")
    user_id = os.getenv("USER_ID")
    if not api_key or not user_id:
        raise RuntimeError("Set COMPOSIO_API_KEY and USER_ID in your environment")

    # Create a Composio Tool Router session for Userflow
    composio = Composio(api_key=api_key)
    session = composio.create(
        user_id=user_id,
        toolkits=["userflow"],
    )
    url = session.mcp.url
    if not url:
        raise ValueError("Composio session did not return an MCP URL")
What's happening:
  • We're creating a Tool Router session that gives your agent access to Userflow tools
  • The create method takes the user ID and specifies which toolkits should be available
  • The returned session.mcp.url is the MCP server URL that your agent will use
7

Initialize the Pydantic AI Agent

python
# Attach the MCP server to a Pydantic AI Agent
userflow_mcp = MCPServerStreamableHTTP(url, headers={"x-api-key": COMPOSIO_API_KEY})
agent = Agent(
    "openai:gpt-5",
    toolsets=[userflow_mcp],
    instructions=(
        "You are a Userflow assistant. Use Userflow tools to help users "
        "with their requests. Ask clarifying questions when needed."
    ),
)
What's happening:
  • The MCP client connects to the Userflow endpoint
  • The agent uses GPT-5 to interpret user commands and perform Userflow operations
  • The instructions field defines the agent's role and behavior
8

Build the chat interface

python
# Simple REPL with message history
history = []
print("Chat started! Type 'exit' or 'quit' to end.\n")
print("Try asking the agent to help you with Userflow.\n")

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", flush=True)

    async with agent.run_stream(user_input, message_history=history) as stream_result:
        collected_text = ""
        async for chunk in stream_result.stream_output():
            text_piece = None
            if isinstance(chunk, str):
                text_piece = chunk
            elif hasattr(chunk, "delta") and isinstance(chunk.delta, str):
                text_piece = chunk.delta
            elif hasattr(chunk, "text"):
                text_piece = chunk.text
            if text_piece:
                collected_text += text_piece
        result = stream_result

    print(f"Agent: {collected_text}\n")
    history = result.all_messages()
What's happening:
  • The agent reads input from the terminal and streams its response
  • Userflow API calls happen automatically under the hood
  • The model keeps conversation history to maintain context across turns
9

Run the application

python
if __name__ == "__main__":
    asyncio.run(main())
What's happening:
  • The asyncio loop launches the agent and keeps it running until you exit

Complete Code

Here's the complete code to get you started with Userflow and Pydantic AI:

python
import asyncio
import os
from dotenv import load_dotenv
from composio import Composio
from pydantic_ai import Agent
from pydantic_ai.mcp import MCPServerStreamableHTTP

load_dotenv()

async def main():
    api_key = os.getenv("COMPOSIO_API_KEY")
    user_id = os.getenv("USER_ID")
    if not api_key or not user_id:
        raise RuntimeError("Set COMPOSIO_API_KEY and USER_ID in your environment")

    # Create a Composio Tool Router session for Userflow
    composio = Composio(api_key=api_key)
    session = composio.create(
        user_id=user_id,
        toolkits=["userflow"],
    )
    url = session.mcp.url
    if not url:
        raise ValueError("Composio session did not return an MCP URL")

    # Attach the MCP server to a Pydantic AI Agent
    userflow_mcp = MCPServerStreamableHTTP(url, headers={"x-api-key": COMPOSIO_API_KEY})
    agent = Agent(
        "openai:gpt-5",
        toolsets=[userflow_mcp],
        instructions=(
            "You are a Userflow assistant. Use Userflow tools to help users "
            "with their requests. Ask clarifying questions when needed."
        ),
    )

    # Simple REPL with message history
    history = []
    print("Chat started! Type 'exit' or 'quit' to end.\n")
    print("Try asking the agent to help you with Userflow.\n")

    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", flush=True)

        async with agent.run_stream(user_input, message_history=history) as stream_result:
            collected_text = ""
            async for chunk in stream_result.stream_output():
                text_piece = None
                if isinstance(chunk, str):
                    text_piece = chunk
                elif hasattr(chunk, "delta") and isinstance(chunk.delta, str):
                    text_piece = chunk.delta
                elif hasattr(chunk, "text"):
                    text_piece = chunk.text
                if text_piece:
                    collected_text += text_piece
            result = stream_result

        print(f"Agent: {collected_text}\n")
        history = result.all_messages()

if __name__ == "__main__":
    asyncio.run(main())

Conclusion

You've built a Pydantic AI agent that can interact with Userflow through Composio's Tool Router. With this setup, your agent can perform real Userflow actions through natural language. You can extend this further by:
  • Adding other toolkits like Gmail, HubSpot, or Salesforce
  • Building a web-based chat interface around this agent
  • Using multiple MCP endpoints to enable cross-app workflows (for example, Gmail + Userflow for workflow automation)
This architecture makes your AI agent "agent-native", able to securely use APIs in a unified, composable way without custom integrations.
TOOLS

Supported Tools

Every Userflow action and event your agent gets out of the box.

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

Create or Update a User

Tool to create a new user or update an existing user in Userflow.

Delete a Content Session

Tool to permanently delete a content session including its associated progress and survey answers.

Delete a Group

Tool to permanently delete a group including all their attributes, memberships and events.

Delete a User

Tool to permanently delete a user including all their attributes, memberships, events and flow history.

Get a Content Object

Tool to retrieve details of a specific content object (flow, checklist, or launcher) by ID.

Get a Content Version

Tool to retrieve details of a specific content version by ID.

Get a Group

Tool to retrieve details of a specific group (company) by group_id.

Get a User

Tool to retrieve details of a specific user by user_id.

List Attribute Definitions

Tool to retrieve all attribute definitions for users and groups tracked by Userflow.

List Content

Tool to retrieve all content (flows, checklists, and launchers) in your Userflow account.

List Content Sessions

Tool to retrieve all content sessions tracking user interactions with content.

List Content Versions

Tool to retrieve all versions of content including survey questions and checklist tasks.

List Event Definitions

Tool to retrieve all event definitions tracked in Userflow.

List Groups

Tool to retrieve all groups (companies) in your Userflow account with pagination and filtering support.

List Users

Tool to retrieve a paginated list of all users.

Remove a User from a Group

Tool to remove a user from a group (group membership).

Track an Event

Tool to record a custom event for a user or group for analytics and personalization.

FRAMEWORKS

How to build Userflow MCP Agent with another framework

OpenAI Agents SDK logo

OpenAI Agents SDK

Use Userflow MCP with OpenAI Agents SDK

Claude Agent SDK logo

Claude Agent SDK

Use Userflow MCP with Claude Agent SDK

Claude Code logo

Claude Code

Use Userflow MCP with Claude Code

Claude Cowork logo

Claude Cowork

Use Userflow MCP with Claude Cowork

Codex logo

Codex

Use Userflow MCP with Codex

OpenClaw logo

OpenClaw

Use Userflow MCP with OpenClaw

Hermes logo

Hermes

Use Userflow MCP with Hermes

CLI logo

CLI

Use Userflow MCP with CLI

Google ADK logo

Google ADK

Use Userflow MCP with Google ADK

LangChain logo

LangChain

Use Userflow MCP with LangChain

Vercel AI SDK logo

Vercel AI SDK

Use Userflow MCP with Vercel AI SDK

Mastra AI logo

Mastra AI

Use Userflow MCP with Mastra AI

LlamaIndex logo

LlamaIndex

Use Userflow MCP with LlamaIndex

CrewAI logo

CrewAI

Use Userflow MCP with CrewAI

FAQ

Frequently asked questions

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.

Yes, you can. Pydantic AI 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.

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.

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.

Start with Userflow.It takes 30 seconds.

Managed auth, hosted MCP servers, and every Userflow tool your agent needs.Free to start.

Start building
Customer stories

Teams ship real agents on Composio

GET STARTED FOR FREEBOOK A DEMO
agent.aiZoomLettaGleanHubSpotAWSWabi

Karan skipped his own birthday party to fix our critical issue. It was 10pm and he diverted his Waymo to help us instead. This really sets the bar — it shows the commitment you need when users rely on your software.

Harsha Gaddipati
Harsha Gaddipati
Co-founder, Slashy

A lot of students tell us that the moment their connected tools start talking to each other inside Opennote feels almost magical. The agent just knows them, and it's immensely helped keep new users on the platform.

Abhi Arya
Abhi Arya
Co-founder, Opennote

We chose Composio over Pipedream because it delivered depth where it mattered — niche tools and tricky edge cases other platforms simply ignored. That gave us confidence to scale without compromising.

Nirman Dave
Nirman Dave
CEO, Zams

As a solo builder, shipping fast is life or death. The only way I can outcompete incumbents is by outmanoeuvring them. Getting bogged down managing agent auth would have been a death sentence.

Ryan Yu
Ryan Yu
Founder, Extra Thursday

Before Composio, adding tool integrations was slow and resource-intensive. Each one could take weeks of engineering time, and maintaining them meant constantly keeping up with API changes.

Tomisin Jenrola
Tomisin Jenrola
Founder & CEO, SwarmZero

With hands-on help from their founder, we integrated Gmail and Google Drive in just 30 minutes. This level of personal support and commitment is exactly what startups should strive for.

Jerome Leclanche
Jerome Leclanche
Co-Founder, Ingram Technologies