# How to integrate Whatsapp MCP with Pydantic AI ```json { "title": "How to integrate Whatsapp MCP with Pydantic AI", "toolkit": "Whatsapp", "toolkit_slug": "whatsapp", "framework": "Pydantic AI", "framework_slug": "pydantic-ai", "url": "https://composio.dev/toolkits/whatsapp/framework/pydantic-ai", "markdown_url": "https://composio.dev/toolkits/whatsapp/framework/pydantic-ai.md", "updated_at": "2026-05-12T10:30:18.573Z" } ``` ## Introduction This guide walks you through connecting Whatsapp to Pydantic AI using the Composio tool router. By the end, you'll have a working Whatsapp agent that can send contact card to new lead, get business profile details for support, list all approved message templates through natural language commands. This guide will help you understand how to give your Pydantic AI agent real control over a Whatsapp account through Composio's Whatsapp MCP server. Before we dive in, let's take a quick look at the key ideas and tools involved. ## Also integrate Whatsapp with - [ChatGPT](https://composio.dev/toolkits/whatsapp/framework/chatgpt) - [Antigravity](https://composio.dev/toolkits/whatsapp/framework/antigravity) - [OpenAI Agents SDK](https://composio.dev/toolkits/whatsapp/framework/open-ai-agents-sdk) - [Claude Agent SDK](https://composio.dev/toolkits/whatsapp/framework/claude-agents-sdk) - [Claude Code](https://composio.dev/toolkits/whatsapp/framework/claude-code) - [Claude Cowork](https://composio.dev/toolkits/whatsapp/framework/claude-cowork) - [Codex](https://composio.dev/toolkits/whatsapp/framework/codex) - [Cursor](https://composio.dev/toolkits/whatsapp/framework/cursor) - [VS Code](https://composio.dev/toolkits/whatsapp/framework/vscode) - [OpenCode](https://composio.dev/toolkits/whatsapp/framework/opencode) - [OpenClaw](https://composio.dev/toolkits/whatsapp/framework/openclaw) - [Hermes](https://composio.dev/toolkits/whatsapp/framework/hermes-agent) - [CLI](https://composio.dev/toolkits/whatsapp/framework/cli) - [Google ADK](https://composio.dev/toolkits/whatsapp/framework/google-adk) - [LangChain](https://composio.dev/toolkits/whatsapp/framework/langchain) - [Vercel AI SDK](https://composio.dev/toolkits/whatsapp/framework/ai-sdk) - [Mastra AI](https://composio.dev/toolkits/whatsapp/framework/mastra-ai) - [LlamaIndex](https://composio.dev/toolkits/whatsapp/framework/llama-index) - [CrewAI](https://composio.dev/toolkits/whatsapp/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 Whatsapp - 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 Whatsapp 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 Whatsapp MCP server, and what's possible with it? The Whatsapp MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your WhatsApp Business account. It provides structured and secure access to your business messaging platform, so your agent can perform actions like sending messages, managing templates, retrieving business info, and automating customer interactions on your behalf. - Automated messaging and contact sharing: Let your agent send messages or share contacts directly with customers who have initiated a conversation, making follow-ups and support quick and seamless. - Template management and automation: Easily create, retrieve, and delete WhatsApp message templates for marketing or transactional outreach, and keep your approved messages organized. - Business profile and phone management: Fetch and update business profile details or pull a full list of WhatsApp Business phone numbers connected to your account for easy management. - Media access and metadata retrieval: Direct your agent to download sent media or fetch detailed information about uploaded files—perfect for handling customer attachments or verifying uploads. - Template approval and status tracking: Automatically check the approval status of message templates, so your agent knows which templates are ready to use or need revision. ## Supported Tools | Tool slug | Name | Description | |---|---|---| | `WHATSAPP_CREATE_MESSAGE_TEMPLATE` | Create message template | Create a new message template for the WhatsApp Business Account. Templates must be approved by WhatsApp before they can be used. Templates are required for marketing messages and messages sent outside the 24-hour window. | | `WHATSAPP_DELETE_MESSAGE_TEMPLATE` | Delete message template | Delete a message template from the WhatsApp Business Account by name. This permanently removes the template and it cannot be recovered. When you delete a template by name, all templates with that name across all languages will be deleted. Names of deleted templates cannot be reused for 30 days. Important: Only delete templates that are no longer needed, as this operation is irreversible. | | `WHATSAPP_GET_BUSINESS_PROFILE` | Get business profile | Get the business profile information for a WhatsApp Business phone number. This includes business details like description, address, website, and contact info. | | `WHATSAPP_GET_MEDIA_INFO` | Get media info | Get metadata and download URL for uploaded WhatsApp media. Returns media ID, download URL (valid for 5 minutes), MIME type, SHA256 hash, and file size. The download URL can be used to retrieve the actual media file. | | `WHATSAPP_GET_MESSAGE_TEMPLATES` | Get message templates | Get all message templates for the WhatsApp Business Account. Templates are required for sending messages outside the 24-hour window and for marketing/utility messages. | | `WHATSAPP_GET_PHONE_NUMBER` | Get phone number | Retrieve detailed information about a specific WhatsApp Business phone number. Returns phone number details including verification status, quality rating, display number, verified business name, throughput limits, and webhook configuration. Use this to check phone number status, settings, and capabilities. To get available phone number IDs, first call WHATSAPP_GET_PHONE_NUMBERS. | | `WHATSAPP_GET_PHONE_NUMBERS` | Get phone numbers | Retrieve all phone numbers registered to your WhatsApp Business Account. Returns phone number IDs, display numbers, verification status, quality ratings, and messaging throughput limits. Use the phone number ID from the response to send WhatsApp messages via other API actions. | | `WHATSAPP_GET_TEMPLATE_STATUS` | Get template status | Get the status and details of a specific message template. This is useful for checking if a template has been approved, rejected, or is still pending review. | | `WHATSAPP_SEND_CONTACTS` | Send contacts | Send contacts WhatsApp number. Note: The message will be delivered to the recipient only if they have initiated a conversation first. | | `WHATSAPP_SEND_INTERACTIVE_BUTTONS` | Send interactive buttons | Send an interactive button message with up to 3 reply buttons to a WhatsApp user. Interactive button messages allow recipients to quickly respond by tapping predefined buttons. Perfect for yes/no questions, multiple choice selections, quick actions, or call-to-action scenarios. IMPORTANT REQUIREMENTS: - The recipient must be a registered WhatsApp user - The recipient must have messaged your business first within the last 24 hours (WhatsApp's customer service window) - You can include 1-3 buttons per message - Each button can have a title (max 20 chars) and unique ID (max 256 chars) Use cases: Customer service menus, appointment confirmations, feedback collection, product selections. | | `WHATSAPP_SEND_INTERACTIVE_LIST` | Send interactive list | Send an interactive list message to a WhatsApp number. List messages display a menu of options organized into sections. Users tap a button to view the list and select one option. Perfect for product catalogs, service menus, or guided workflows. Supports up to 10 sections with up to 10 items per section (100 total options). Note: Recipients must have messaged you first within the last 24 hours to receive this message. | | `WHATSAPP_SEND_LOCATION` | Send location | Send a location message with coordinates, name, and address to a WhatsApp user. This action allows you to share location information through WhatsApp Business API. The location message includes latitude/longitude coordinates, a location name, and address. Important: The recipient must have an active WhatsApp account. Additionally, you can only send free-form messages (like location messages) within the 24-hour customer service window after the recipient has initiated contact with your business. Outside this window, you must use approved message templates. Common error codes: - 133010: Recipient's phone number doesn't have a WhatsApp account - 131026: Message undeliverable (recipient may have blocked your business number) - 131047: Re-engagement message (outside 24-hour window, need to use template) | | `WHATSAPP_SEND_MEDIA` | Send media | Send a media message to a WhatsApp number. Note: The media will be delivered to the recipient only if they have texted first. | | `WHATSAPP_SEND_MEDIA_BY_ID` | Send media by | Send media using a media ID from previously uploaded media. This is more efficient than sending media by URL as the media is already on WhatsApp servers. Use upload_media action first to get the media ID. Note: The media will be delivered to the recipient only if they have texted first. | | `WHATSAPP_SEND_MESSAGE` | Send message | Send a text message to a WhatsApp user. Important: The recipient phone number must be registered on WhatsApp and must have initiated a conversation with your business within the last 24 hours, OR you must use a template message (see WHATSAPP_SEND_TEMPLATE_MESSAGE) for the first message outside the 24-hour window. For test accounts, recipient numbers must be added to the test recipient list in Meta Business Suite before sending messages. | | `WHATSAPP_SEND_TEMPLATE_MESSAGE` | Send template message | Send a template message to a WhatsApp number. | | `WHATSAPP_UPLOAD_MEDIA` | Upload media | Upload media files (images, videos, audio, documents, stickers) to WhatsApp servers. The uploaded media gets a media ID that can be used in send_media or other messaging actions. Supported formats: - Images: JPEG, PNG (max 5MB) - Videos: MP4, 3GPP (max 16MB) - Audio: AAC, M4A, AMR, MP3, OGG (max 16MB) - Documents: PDF, DOC, DOCX, PPT, PPTX, XLS, XLSX (max 100MB) - Stickers: WebP (max 500KB, 512x512 pixels) | ## Supported Triggers | Trigger slug | Name | Description | |---|---|---| | `WHATSAPP_MESSAGE_STATUS_UPDATED_TRIGGER` | Message Status Updated | Triggers when a WhatsApp message status changes. IMPORTANT LIMITATION: WhatsApp Cloud API does not provide a native polling endpoint for message status. Status updates are ONLY delivered via webhooks in real-time. This trigger cannot directly poll the WhatsApp API for status updates. This trigger will return empty results as WhatsApp does not support this operation. To track message status updates, you must: 1. Set up a webhook endpoint to receive status notifications from WhatsApp 2. Store the webhook data in your own database 3. Use a different mechanism to query your stored webhook data For more information, see: - https://developers.facebook.com/docs/whatsapp/cloud-api/webhooks | ## Creating MCP Server - Stand-alone vs Composio SDK The Whatsapp MCP server is an implementation of the Model Context Protocol that connects your AI agent to Whatsapp. It provides structured and secure access so your agent can perform Whatsapp 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 Whatsapp - 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 Whatsapp - MCPServerStreamableHTTP connects to the Whatsapp 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 Whatsapp 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 Whatsapp composio = Composio(api_key=api_key) session = composio.create( user_id=user_id, toolkits=["whatsapp"], ) 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 Whatsapp endpoint - The agent uses GPT-5 to interpret user commands and perform Whatsapp operations - The instructions field defines the agent's role and behavior ```python # Attach the MCP server to a Pydantic AI Agent whatsapp_mcp = MCPServerStreamableHTTP(url, headers={"x-api-key": COMPOSIO_API_KEY}) agent = Agent( "openai:gpt-5", toolsets=[whatsapp_mcp], instructions=( "You are a Whatsapp assistant. Use Whatsapp 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 - Whatsapp 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 Whatsapp.\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 Whatsapp composio = Composio(api_key=api_key) session = composio.create( user_id=user_id, toolkits=["whatsapp"], ) 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 whatsapp_mcp = MCPServerStreamableHTTP(url, headers={"x-api-key": COMPOSIO_API_KEY}) agent = Agent( "openai:gpt-5", toolsets=[whatsapp_mcp], instructions=( "You are a Whatsapp assistant. Use Whatsapp 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 Whatsapp.\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 Whatsapp through Composio's Tool Router. With this setup, your agent can perform real Whatsapp 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 + Whatsapp 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 Whatsapp MCP Agent with another framework - [ChatGPT](https://composio.dev/toolkits/whatsapp/framework/chatgpt) - [Antigravity](https://composio.dev/toolkits/whatsapp/framework/antigravity) - [OpenAI Agents SDK](https://composio.dev/toolkits/whatsapp/framework/open-ai-agents-sdk) - [Claude Agent SDK](https://composio.dev/toolkits/whatsapp/framework/claude-agents-sdk) - [Claude Code](https://composio.dev/toolkits/whatsapp/framework/claude-code) - [Claude Cowork](https://composio.dev/toolkits/whatsapp/framework/claude-cowork) - [Codex](https://composio.dev/toolkits/whatsapp/framework/codex) - [Cursor](https://composio.dev/toolkits/whatsapp/framework/cursor) - [VS Code](https://composio.dev/toolkits/whatsapp/framework/vscode) - [OpenCode](https://composio.dev/toolkits/whatsapp/framework/opencode) - [OpenClaw](https://composio.dev/toolkits/whatsapp/framework/openclaw) - [Hermes](https://composio.dev/toolkits/whatsapp/framework/hermes-agent) - [CLI](https://composio.dev/toolkits/whatsapp/framework/cli) - [Google ADK](https://composio.dev/toolkits/whatsapp/framework/google-adk) - [LangChain](https://composio.dev/toolkits/whatsapp/framework/langchain) - [Vercel AI SDK](https://composio.dev/toolkits/whatsapp/framework/ai-sdk) - [Mastra AI](https://composio.dev/toolkits/whatsapp/framework/mastra-ai) - [LlamaIndex](https://composio.dev/toolkits/whatsapp/framework/llama-index) - [CrewAI](https://composio.dev/toolkits/whatsapp/framework/crew-ai) ## Related Toolkits - [Gmail](https://composio.dev/toolkits/gmail) - Gmail is Google's email service with powerful spam protection, search, and G Suite integration. It keeps your inbox organized and makes communication fast and reliable. - [Outlook](https://composio.dev/toolkits/outlook) - Outlook is Microsoft's email and calendaring platform for unified communications and scheduling. It helps users stay organized with powerful email, contacts, and calendar management. - [Slack](https://composio.dev/toolkits/slack) - Slack is a channel-based messaging platform for teams and organizations. It helps people collaborate in real time, share files, and connect all their tools in one place. - [Gong](https://composio.dev/toolkits/gong) - Gong is a platform for video meetings, call recording, and team collaboration. It helps teams capture conversations, analyze calls, and turn insights into action. - [Microsoft teams](https://composio.dev/toolkits/microsoft_teams) - Microsoft Teams is a collaboration platform that combines chat, meetings, and file sharing within Microsoft 365. It keeps distributed teams connected and productive through seamless virtual communication. - [Slackbot](https://composio.dev/toolkits/slackbot) - Slackbot is a conversational automation tool for Slack that handles reminders, notifications, and automated responses. It boosts team productivity by streamlining onboarding, answering FAQs, and managing timely alerts—all right inside Slack. - [2chat](https://composio.dev/toolkits/_2chat) - 2chat is an API platform for WhatsApp and multichannel text messaging. It streamlines chat automation, group management, and real-time messaging for developers. - [Agent mail](https://composio.dev/toolkits/agent_mail) - Agent mail provides AI agents with dedicated email inboxes for sending, receiving, and managing emails. It empowers agents to communicate autonomously with people, services, and other agents—no human intervention needed. - [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. - [Chatwork](https://composio.dev/toolkits/chatwork) - Chatwork is a team communication platform with group chats, file sharing, and task management. It helps businesses boost collaboration and streamline productivity. - [Clickmeeting](https://composio.dev/toolkits/clickmeeting) - ClickMeeting is a cloud-based platform for running online meetings and webinars. It helps businesses and individuals host, manage, and engage virtual audiences with ease. - [Confluence](https://composio.dev/toolkits/confluence) - Confluence is Atlassian's team collaboration and knowledge management platform. It helps your team organize, share, and update documents and project content in one secure workspace. - [Dailybot](https://composio.dev/toolkits/dailybot) - DailyBot streamlines team collaboration with chat-based standups, reminders, and polls. It keeps work flowing smoothly in your favorite messaging platforms. - [Dialmycalls](https://composio.dev/toolkits/dialmycalls) - Dialmycalls is a mass notification service for sending voice and text messages to contacts. It helps teams and organizations quickly broadcast urgent alerts and updates. - [Dialpad](https://composio.dev/toolkits/dialpad) - Dialpad is a cloud-based business phone and contact center system for teams. It unifies voice, video, messaging, and meetings across your devices. - [Discord](https://composio.dev/toolkits/discord) - Discord is a real-time messaging and VoIP platform for communities and teams. It lets users chat, share media, and collaborate across public and private channels. - [Discordbot](https://composio.dev/toolkits/discordbot) - Discordbot is an automation tool for Discord servers that handles moderation, messaging, and user engagement. It helps communities run smoothly by automating routine and complex tasks. - [Echtpost](https://composio.dev/toolkits/echtpost) - Echtpost is a secure digital communication platform for encrypted document and message exchange. It ensures confidential data stays private and protected during transmission. - [Egnyte](https://composio.dev/toolkits/egnyte) - Egnyte is a cloud-based platform for secure file sharing, storage, and governance. It helps teams collaborate efficiently while maintaining data compliance and security. - [Google Meet](https://composio.dev/toolkits/googlemeet) - Google Meet is a secure video conferencing platform for virtual meetings, chat, and screen sharing. It helps teams connect, collaborate, and communicate seamlessly from anywhere. ## Frequently Asked Questions ### What are the differences in Tool Router MCP and Whatsapp MCP? With a standalone Whatsapp MCP server, the agents and LLMs can only access a fixed set of Whatsapp tools tied to that server. However, with the Composio Tool Router, agents can dynamically load tools from Whatsapp 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 Whatsapp tools. ### Can I manage the permissions and scopes for Whatsapp while using Tool Router? Yes, absolutely. You can configure which Whatsapp 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 Whatsapp data and credentials are handled as safely as possible. --- [See all toolkits](https://composio.dev/toolkits) · [Composio docs](https://docs.composio.dev/llms.txt)