# How to integrate Whautomate MCP with Pydantic AI ```json { "title": "How to integrate Whautomate MCP with Pydantic AI", "toolkit": "Whautomate", "toolkit_slug": "whautomate", "framework": "Pydantic AI", "framework_slug": "pydantic-ai", "url": "https://composio.dev/toolkits/whautomate/framework/pydantic-ai", "markdown_url": "https://composio.dev/toolkits/whautomate/framework/pydantic-ai.md", "updated_at": "2026-05-12T10:30:20.623Z" } ``` ## Introduction This guide walks you through connecting Whautomate to Pydantic AI using the Composio tool router. By the end, you'll have a working Whautomate agent that can add a new contact for follow-up, fetch all scheduled broadcasts this week, get chat messages for a specific contact through natural language commands. This guide will help you understand how to give your Pydantic AI agent real control over a Whautomate account through Composio's Whautomate MCP server. Before we dive in, let's take a quick look at the key ideas and tools involved. ## Also integrate Whautomate with - [OpenAI Agents SDK](https://composio.dev/toolkits/whautomate/framework/open-ai-agents-sdk) - [Claude Agent SDK](https://composio.dev/toolkits/whautomate/framework/claude-agents-sdk) - [Claude Code](https://composio.dev/toolkits/whautomate/framework/claude-code) - [Claude Cowork](https://composio.dev/toolkits/whautomate/framework/claude-cowork) - [Codex](https://composio.dev/toolkits/whautomate/framework/codex) - [OpenClaw](https://composio.dev/toolkits/whautomate/framework/openclaw) - [Hermes](https://composio.dev/toolkits/whautomate/framework/hermes-agent) - [CLI](https://composio.dev/toolkits/whautomate/framework/cli) - [Google ADK](https://composio.dev/toolkits/whautomate/framework/google-adk) - [LangChain](https://composio.dev/toolkits/whautomate/framework/langchain) - [Vercel AI SDK](https://composio.dev/toolkits/whautomate/framework/ai-sdk) - [Mastra AI](https://composio.dev/toolkits/whautomate/framework/mastra-ai) - [LlamaIndex](https://composio.dev/toolkits/whautomate/framework/llama-index) - [CrewAI](https://composio.dev/toolkits/whautomate/framework/crew-ai) ## 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 Whautomate - 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 Whautomate 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 Whautomate MCP server, and what's possible with it? The Whautomate MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Whautomate account. It provides structured and secure access to customer engagement resources, so your agent can manage contacts, schedule broadcasts, retrieve chat histories, and organize messaging segments automatically on your behalf. - Contact management and automation: Quickly add new contacts or retrieve lists of WhatsApp contacts to streamline customer engagement and outreach. - Broadcast scheduling and tracking: Instruct your agent to fetch, inspect, or get details on message broadcasts—including status tracking and filtering by date or type. - Chat history and message retrieval: Have your agent pull detailed chat messages for individual contacts, so you can review conversations, follow up intelligently, or analyze engagement history. - Segment and service organization: Effortlessly manage audience segments and services—fetching, deleting, or organizing them to keep your communication campaigns targeted and up-to-date. - Webhook and integration oversight: Retrieve all registered webhooks to monitor and audit external integrations, ensuring your automations stay connected and reliable. ## Supported Tools | Tool slug | Name | Description | |---|---|---| | `WHAUTOMATE_ADD_CONTACT` | Add Contact | Tool to add a new contact. Use when you need to programmatically create contacts via the API. | | `WHAUTOMATE_DELETE_SEGMENT` | Delete Segment | Tool to delete a specific segment. Use when you need to remove a segment by its ID. Use after confirming you have the correct segmentId. | | `WHAUTOMATE_DELETE_SERVICE_CATEGORY` | Delete Service Category | Tool to delete a service category. Use when you need to remove a specific service category by its ID. Use after confirming you have the correct serviceCategoryId. | | `WHAUTOMATE_GET_ACCOUNT_INFO` | Get Account Info | Tool to retrieve account information for the authenticated user. Use when you need to fetch account details like account name and owner email. | | `WHAUTOMATE_GET_ALL_WEBHOOKS` | Get All Webhooks | Tool to retrieve all registered webhooks. Use after authenticating to audit or inspect existing webhook subscriptions. | | `WHAUTOMATE_GET_BROADCAST_BY_ID` | Get Broadcast By ID | Tool to retrieve a specific broadcast's details. Use when you have a broadcast ID and need its metadata. Use after confirming the broadcastId is valid, as this returns detailed broadcast data. | | `WHAUTOMATE_GET_BROADCASTS` | Get Broadcasts | Tool to retrieve a list of broadcasts. Use when you need to fetch broadcasts with optional filters such as status or date ranges. Example: "Get all scheduled broadcasts after 2023-01-01T00:00:00Z." | | `WHAUTOMATE_GET_CONTACTS` | Get Contacts | Tool to retrieve a list of contacts. Use when you need to fetch contacts from WhatsApp with optional pagination and filters. | | `WHAUTOMATE_GET_MESSAGES_OF_CONTACT` | Get Messages of Contact | Tool to retrieve chat messages for a specific contact. Use after providing a valid contactId. Supports pagination and optional date filtering. | | `WHAUTOMATE_GET_SEGMENTS` | Get Segments | Tool to retrieve a list of segments. Use when you need to fetch segments with optional name filtering and pagination. Segments can be used to organize clients and contacts into groups based on various criteria. | | `WHAUTOMATE_GET_SERVICE_BY_ID` | Get Service By Id | Tool to retrieve details of a specific service by its unique ID. Use when you need comprehensive service information. | | `WHAUTOMATE_GET_SERVICE_CATEGORIES` | Get Service Categories | Tool to retrieve a list of service categories. Use when you need to list categories with optional pagination. | | `WHAUTOMATE_GET_SERVICES` | Get Services | Tool to retrieve a list of services with optional filters. Use when you need to fetch available services for display or scheduling. | | `WHAUTOMATE_GET_STAFF_AVAILABILITY_BLOCKS` | Get Staff Availability Blocks | Tool to retrieve a staff member's blocked time schedule over a date range. Use when you need to view unavailable slots after confirming staffId and desired date range. | | `WHAUTOMATE_GET_STAFF_BY_ID` | Get Staff By ID | Tool to retrieve detailed information about a specific staff member. Use when you have a valid staff ID and need full profile details. Use after confirming staffId. | | `WHAUTOMATE_GET_STAFFS` | Get Staffs | Tool to retrieve a list of staff members. Use when you need to list staff with optional pagination or search filters. | | `WHAUTOMATE_UPDATE_SERVICE` | Update Service | Tool to update an existing Whautomate service. Use when you need to modify service attributes like name, pricing, duration, or active status. | ## Supported Triggers None listed. ## Creating MCP Server - Stand-alone vs Composio SDK The Whautomate MCP server is an implementation of the Model Context Protocol that connects your AI agent to Whautomate. It provides structured and secure access so your agent can perform Whautomate operations on your behalf through a secure, permission-based interface. 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 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 ### 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 the required libraries. What's happening: - composio connects your agent to external SaaS tools like Whautomate - pydantic-ai lets you create structured AI agents with tool support - python-dotenv loads your environment variables securely from a .env file ```bash pip install composio pydantic-ai python-dotenv ``` ### 3. Set up environment variables 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 ```bash COMPOSIO_API_KEY=your_composio_api_key_here USER_ID=your_user_id_here OPENAI_API_KEY=your_openai_api_key ``` ### 4. Import dependencies What's happening: - We load environment variables and import required modules - Composio manages connections to Whautomate - MCPServerStreamableHTTP connects to the Whautomate MCP server endpoint - Agent from Pydantic AI lets you define and run the AI assistant ```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() ``` ### 5. Create a Tool Router Session What's happening: - We're creating a Tool Router session that gives your agent access to Whautomate 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 ```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 Whautomate composio = Composio(api_key=api_key) session = composio.create( user_id=user_id, toolkits=["whautomate"], ) url = session.mcp.url if not url: raise ValueError("Composio session did not return an MCP URL") ``` ### 6. Initialize the Pydantic AI Agent What's happening: - The MCP client connects to the Whautomate endpoint - The agent uses GPT-5 to interpret user commands and perform Whautomate operations - The instructions field defines the agent's role and behavior ```python # Attach the MCP server to a Pydantic AI Agent whautomate_mcp = MCPServerStreamableHTTP(url, headers={"x-api-key": COMPOSIO_API_KEY}) agent = Agent( "openai:gpt-5", toolsets=[whautomate_mcp], instructions=( "You are a Whautomate assistant. Use Whautomate tools to help users " "with their requests. Ask clarifying questions when needed." ), ) ``` ### 7. Build the chat interface What's happening: - The agent reads input from the terminal and streams its response - Whautomate API calls happen automatically under the hood - The model keeps conversation history to maintain context across turns ```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 Whautomate.\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() ``` ### 8. Run the application What's happening: - The asyncio loop launches the agent and keeps it running until you exit ```python if __name__ == "__main__": asyncio.run(main()) ``` ## Complete Code ```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 Whautomate composio = Composio(api_key=api_key) session = composio.create( user_id=user_id, toolkits=["whautomate"], ) 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 whautomate_mcp = MCPServerStreamableHTTP(url, headers={"x-api-key": COMPOSIO_API_KEY}) agent = Agent( "openai:gpt-5", toolsets=[whautomate_mcp], instructions=( "You are a Whautomate assistant. Use Whautomate 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 Whautomate.\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 Whautomate through Composio's Tool Router. With this setup, your agent can perform real Whautomate 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 + Whautomate for workflow automation) This architecture makes your AI agent "agent-native", able to securely use APIs in a unified, composable way without custom integrations. ## How to build Whautomate MCP Agent with another framework - [OpenAI Agents SDK](https://composio.dev/toolkits/whautomate/framework/open-ai-agents-sdk) - [Claude Agent SDK](https://composio.dev/toolkits/whautomate/framework/claude-agents-sdk) - [Claude Code](https://composio.dev/toolkits/whautomate/framework/claude-code) - [Claude Cowork](https://composio.dev/toolkits/whautomate/framework/claude-cowork) - [Codex](https://composio.dev/toolkits/whautomate/framework/codex) - [OpenClaw](https://composio.dev/toolkits/whautomate/framework/openclaw) - [Hermes](https://composio.dev/toolkits/whautomate/framework/hermes-agent) - [CLI](https://composio.dev/toolkits/whautomate/framework/cli) - [Google ADK](https://composio.dev/toolkits/whautomate/framework/google-adk) - [LangChain](https://composio.dev/toolkits/whautomate/framework/langchain) - [Vercel AI SDK](https://composio.dev/toolkits/whautomate/framework/ai-sdk) - [Mastra AI](https://composio.dev/toolkits/whautomate/framework/mastra-ai) - [LlamaIndex](https://composio.dev/toolkits/whautomate/framework/llama-index) - [CrewAI](https://composio.dev/toolkits/whautomate/framework/crew-ai) ## Related Toolkits - [Aeroleads](https://composio.dev/toolkits/aeroleads) - Aeroleads is a B2B lead generation platform for finding business emails and phone numbers. Grow your sales pipeline faster with powerful prospecting tools. - [Autobound](https://composio.dev/toolkits/autobound) - Autobound is an AI-powered sales engagement platform that crafts hyper-personalized outreach and insights. It helps sales teams boost response rates and close more deals through tailored content and recommendations. - [Better proposals](https://composio.dev/toolkits/better_proposals) - Better Proposals is a web-based tool for crafting and sending professional proposals. It helps teams impress clients and close deals faster with slick, easy-to-use templates. - [Bidsketch](https://composio.dev/toolkits/bidsketch) - Bidsketch is a proposal software that helps businesses create professional proposals quickly and efficiently. It streamlines the proposal process, saving time while boosting client win rates. - [Bolna](https://composio.dev/toolkits/bolna) - Bolna is an AI platform for building conversational voice agents. It helps businesses automate support and streamline interactions through natural, voice-powered conversations. - [Botsonic](https://composio.dev/toolkits/botsonic) - Botsonic is a no-code AI chatbot builder for easily creating and deploying chatbots to your website. It empowers businesses to offer conversational experiences without writing code. - [Botstar](https://composio.dev/toolkits/botstar) - BotStar is a comprehensive chatbot platform for designing, developing, and training chatbots visually on Messenger and websites. It helps businesses automate conversations and customer interactions without coding. - [Callerapi](https://composio.dev/toolkits/callerapi) - CallerAPI is a white-label caller identification platform for branded caller ID and fraud prevention. It helps businesses boost customer trust while stopping spam, fraud, and robocalls. - [Callingly](https://composio.dev/toolkits/callingly) - Callingly is a lead response management platform that automates immediate call and text follow-ups with new leads. It helps sales teams boost response speed and close more deals by connecting seamlessly with CRMs and lead sources. - [Callpage](https://composio.dev/toolkits/callpage) - Callpage is a lead capture platform that lets businesses instantly connect with website visitors via callback. It boosts lead generation and increases your sales conversion rates. - [Clearout](https://composio.dev/toolkits/clearout) - Clearout is an AI-powered service for verifying, finding, and enriching email addresses. It boosts deliverability and helps you discover high-quality leads effortlessly. - [Clientary](https://composio.dev/toolkits/clientary) - Clientary is a platform for managing clients, invoices, projects, proposals, and more. It streamlines client work and saves you serious admin time. - [Convolo ai](https://composio.dev/toolkits/convolo_ai) - Convolo ai is an AI-powered communications platform for sales teams. It accelerates lead response and improves conversion rates by automating calls and integrating workflows. - [Delighted](https://composio.dev/toolkits/delighted) - Delighted is a customer feedback platform based on the Net Promoter System®. It helps you quickly gather, track, and act on customer sentiment. - [Emelia](https://composio.dev/toolkits/emelia) - Emelia is an all-in-one B2B prospecting platform for cold-email, LinkedIn outreach, and prospect research. It streamlines outbound campaigns so you can find, engage, and warm up leads faster. - [Findymail](https://composio.dev/toolkits/findymail) - Findymail is a B2B data provider offering verified email and phone contacts for sales prospecting. Enhance outreach with automated exports, email verification, and CRM enrichment. - [Freshdesk](https://composio.dev/toolkits/freshdesk) - Freshdesk is customer support software with ticketing and automation tools. It helps teams streamline helpdesk operations for faster, better customer support. - [Fullenrich](https://composio.dev/toolkits/fullenrich) - FullEnrich is a B2B contact enrichment platform that aggregates emails and phone numbers from 15+ data vendors. Instantly find and verify lead contact data to boost your outreach. - [Gatherup](https://composio.dev/toolkits/gatherup) - GatherUp is a customer feedback and online review management platform. It helps businesses boost their reputation by streamlining how they collect and manage customer feedback. - [Getprospect](https://composio.dev/toolkits/getprospect) - Getprospect is a business email discovery tool with LinkedIn integration. Use it to quickly find and verify professional email addresses. ## Frequently Asked Questions ### What are the differences in Tool Router MCP and Whautomate MCP? With a standalone Whautomate MCP server, the agents and LLMs can only access a fixed set of Whautomate tools tied to that server. However, with the Composio Tool Router, agents can dynamically load tools from Whautomate and many other apps based on the task at hand, all through a single MCP endpoint. ### Can I use Tool Router MCP with Pydantic AI? 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 Whautomate tools. ### Can I manage the permissions and scopes for Whautomate while using Tool Router? Yes, absolutely. You can configure which Whautomate 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 Whautomate data and credentials are handled as safely as possible. --- [See all toolkits](https://composio.dev/toolkits) · [Composio docs](https://docs.composio.dev/llms.txt)