How to integrate Zulip MCP with Pydantic AI

GET STARTED FOR FREE
Framework Integration Gradient
Zulip Logo
Pydantic AI Logo
divider

Introduction

This guide walks you through connecting Zulip to Pydantic AI using the Composio tool router. By the end, you'll have a working Zulip agent that can post daily standup summary to #team stream, list unread messages from #support stream, reply to the latest thread in #engineering through natural language commands.

This guide will help you understand how to give your Pydantic AI agent real control over a Zulip account through Composio's Zulip MCP server.

Before we dive in, let's take a quick look at the key ideas and tools involved.

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 Zulip
  • 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 Zulip 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 Zulip MCP server, and what's possible with it?

The Zulip MCP server is an implementation of the Model Context Protocol that connects your AI agent and assistants like Claude, Cursor, etc directly to your Zulip account. It provides structured and secure access so your agent can perform Zulip operations on your behalf.

Supported Tools & Triggers

Tools
Add Alert WordsTool to add alert words to the current user's configuration.
Add APNs Device TokenTool to add an APNs (Apple Push Notification service) device token to Zulip.
Add Default StreamTool to add a channel as a default stream in Zulip.
Add LinkifierTool to add a linkifier to a Zulip realm.
Add Navigation ViewTool to add a navigation view in Zulip.
Add ReactionTool to add an emoji reaction to a Zulip message.
Archive ChannelTool to archive a channel in Zulip.
Check Messages Match NarrowTool to check if specific messages match a narrow filter.
Create BigBlueButton video callTool to create a BigBlueButton video call in Zulip.
Create ChannelTool to create a new channel in Zulip.
Create Channel FolderTool to create a new channel folder in Zulip.
Create custom profile fieldTool to create a custom profile field in Zulip.
Create DraftsTool to create one or more draft messages in Zulip.
Create reusable invitation linkTool to create a reusable invitation link for the Zulip organization.
Create Message ReminderTool to create a message reminder in Zulip.
Create Saved SnippetTool to create a saved snippet in Zulip.
Create Scheduled MessageTool to create a scheduled message in Zulip.
Delete DraftTool to delete a draft in Zulip.
Delete MessageTool to delete a message in Zulip.
Delete Event QueueTool to delete an event queue previously registered via POST /api/v1/register.
Delete ReminderTool to delete a reminder from Zulip.
Delete Saved SnippetTool to delete a saved snippet by its ID.
Delete Scheduled MessageTool to delete a scheduled message in Zulip.
Delete TopicTool to delete a topic from a Zulip channel/stream.
Edit DraftTool to edit an existing draft message in Zulip.
Edit Navigation ViewTool to update a navigation view in Zulip.
Edit Saved SnippetTool to edit a saved snippet by updating its title and/or content.
Export RealmTool to create a Zulip realm data export.
Get alert wordsTool to retrieve all configured alert words for the authenticated user.
Get Another User PresenceTool to get the presence status for a specific user in Zulip.
Get AttachmentsTool to retrieve metadata on files uploaded by the requesting user.
Get Channel FoldersTool to retrieve all channel folders in the organization, sorted by display order.
Get custom emojiTool to retrieve all custom emoji configured in the Zulip realm.
Get custom profile fieldsTool to get all custom profile fields configured for the Zulip realm.
Get draftsTool to fetch all drafts for the authenticated user.
Get EventsTool to get events from a Zulip event queue.
Get file temporary URLTool to get a public temporary URL for an uploaded file in Zulip.
Get realm iconTool to retrieve the URL of the Zulip realm's icon.
Get all invitationsTool to retrieve all unexpired invitations for the Zulip organization.
Get user group membership statusTool to check if a user is a member of a specific user group.
Get linkifiersTool to retrieve all configured linkifiers in the Zulip realm.
Get messageTool to fetch a single message by ID from Zulip.
Get Message HistoryTool to fetch the complete edit history of a Zulip message.
Get MessagesTool to fetch messages from Zulip.
Get Navigation ViewsTool to fetch all navigation views for the authenticated user.
Get own userTool to retrieve the profile information for the authenticated user.
Get Read ReceiptsTool to retrieve read receipts for a message in Zulip.
Get realm export consentsTool to retrieve data export consent state for users in a realm.
Get all data exportsTool to retrieve all data exports for the Zulip organization.
Get Realm PresenceTool to get the presence status for all users in the Zulip realm.
Get remindersTool to fetch all undelivered reminders for the authenticated user.
Get Saved SnippetsTool to fetch all saved snippets for the authenticated user.
Get Scheduled MessagesTool to fetch all scheduled messages for the authenticated user.
Get server settingsTool to retrieve server configuration and available authentication methods.
Get Channel by IDTool to get detailed information about a Zulip channel by its ID.
Get channel email addressTool to retrieve the email address for a Zulip channel.
Get Channel IDTool to get a channel's unique ID by its name.
Get All ChannelsTool to retrieve all channels (streams) in Zulip that match specified filters.
Get stream topicsTool to retrieve all topics in a Zulip channel.
Get Channel SubscribersTool to get all subscribers of a Zulip channel.
Get SubscriptionsTool to retrieve all channels (streams) the authenticated user is subscribed to.
Get subscription statusTool to check whether a specific user is subscribed to a particular channel (stream).
Get user by emailTool to fetch a user by email address from Zulip.
Get user channelsTool to retrieve the list of channel IDs that a specific user is subscribed to.
Get user group membersTool to retrieve all members of a specific user group.
Get user groupsTool to retrieve all user groups in the Zulip organization.
Get user group subgroupsTool to retrieve subgroups of a user group.
Get user statusTool to retrieve the status currently set by a user in the Zulip organization.
Mark All Messages as ReadTool to mark all messages as read for the authenticated user.
Mark Stream as ReadTool to mark all messages in a Zulip channel as read.
Mark Topic as ReadTool to mark all messages in a topic as read.
Mute TopicTool to mute or unmute a topic in a Zulip channel.
Reactivate UserTool to reactivate a deactivated user in Zulip.
Register Push DeviceTool to register an E2EE (end-to-end encrypted) push device for mobile notifications.
Register Event QueueTool to register an event queue for receiving Zulip events.
Remove Alert WordsTool to remove alert words from the current user's configuration.
Remove AttachmentTool to delete an attachment in Zulip.
Remove Code PlaygroundTool to remove a code playground from a Zulip realm.
Remove Default StreamTool to remove a channel from default streams in Zulip.
Remove FCM TokenTool to remove an FCM registration token for Android push notifications.
Remove LinkifierTool to remove a linkifier from a Zulip realm.
Remove Navigation ViewTool to remove a navigation view in Zulip.
Remove ReactionTool to remove an emoji reaction from a Zulip message.
Render MessageTool to render a message to HTML in Zulip.
Reorder Channel FoldersTool to reorder channel folders in Zulip.
Reorder Custom Profile FieldsTool to reorder custom profile fields in Zulip.
Reorder LinkifiersTool to reorder linkifiers in Zulip.
Revoke Email InvitationTool to revoke an email invitation in Zulip.
Revoke reusable invitation linkTool to revoke a reusable invitation link for the Zulip organization.
Send MessageTool to send a message in Zulip.
Send Test NotificationTool to send a test notification to mobile device(s).
Set Typing StatusTool to set typing status in Zulip.
Set Typing Status for Message EditTool to set typing status when editing a message in Zulip.
Subscribe to ChannelTool to subscribe users to one or more Zulip channels.
Test Welcome Bot Custom MessageTool to test welcome bot custom message in Zulip.
Unsubscribe From ChannelTool to unsubscribe from one or more channels (streams) in Zulip.
Update Channel FolderTool to update a channel folder in Zulip.
Update LinkifierTool to update a linkifier in a Zulip realm.
Update MessageTool to edit a message in Zulip.
Update Message FlagsTool to update personal message flags in Zulip.
Update Message Flags for NarrowTool to update personal message flags (e.
Update Realm User Settings DefaultsTool to update realm-level defaults of user settings in Zulip.
Update Scheduled MessageTool to edit a scheduled message in Zulip.
Update SettingsTool to update user settings in Zulip.
Update StatusTool to update your status in Zulip.
Update status for userTool to update the status for a specific user in the Zulip organization.
Update ChannelTool to update a channel in Zulip.
Update SubscriptionsTool to update channel subscriptions by subscribing to new channels or unsubscribing from existing ones.
Update Subscription SettingsTool to update the user's personal settings for channels they are subscribed to.
Update user by emailTool to update a user by email address in Zulip.
Update User TopicTool to update personal preferences for a topic in a Zulip channel.

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

What is Tool Router?

Composio's Tool Router 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 Tool Router

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

How the Tool Router works

The Tool Router 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

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

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.

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 Zulip
  • pydantic-ai lets you create structured AI agents with tool support
  • python-dotenv loads your environment variables securely from a .env file

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

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 Zulip
  • MCPServerStreamableHTTP connects to the Zulip MCP server endpoint
  • Agent from Pydantic AI lets you define and run the AI assistant

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 Zulip
    composio = Composio(api_key=api_key)
    session = composio.create(
        user_id=user_id,
        toolkits=["zulip"],
    )
    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 Zulip 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

Initialize the Pydantic AI Agent

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

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 Zulip.\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
  • Zulip API calls happen automatically under the hood
  • The model keeps conversation history to maintain context across turns

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 Zulip 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 Zulip
    composio = Composio(api_key=api_key)
    session = composio.create(
        user_id=user_id,
        toolkits=["zulip"],
    )
    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
    zulip_mcp = MCPServerStreamableHTTP(url, headers={"x-api-key": COMPOSIO_API_KEY})
    agent = Agent(
        "openai:gpt-5",
        toolsets=[zulip_mcp],
        instructions=(
            "You are a Zulip assistant. Use Zulip 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 Zulip.\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 Zulip through Composio's Tool Router. With this setup, your agent can perform real Zulip 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 + Zulip 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 Zulip MCP Agent with another framework

OpenAI Agents SDK

OpenAI Agents SDK

Use Zulip MCP with OpenAI Agents SDK

Claude Agent SDK

Claude Agent SDK

Use Zulip MCP with Claude Agent SDK

Google ADK

Google ADK

Use Zulip MCP with Google ADK

LangChain

LangChain

Use Zulip MCP with LangChain

Vercel AI SDK

Vercel AI SDK

Use Zulip MCP with Vercel AI SDK

Mastra AI

Mastra AI

Use Zulip MCP with Mastra AI

LlamaIndex

LlamaIndex

Use Zulip MCP with LlamaIndex

CrewAI

CrewAI

Use Zulip MCP with CrewAI

Claude Code

Claude Code

Use Zulip MCP with Claude Code

Codex

Codex

Use Zulip MCP with Codex

FAQ

What are the differences in Tool Router MCP and Zulip MCP?

With a standalone Zulip MCP server, the agents and LLMs can only access a fixed set of Zulip tools tied to that server. However, with the Composio Tool Router, agents can dynamically load tools from Zulip 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 Zulip tools.

Can I manage the permissions and scopes for Zulip while using Tool Router?

Yes, absolutely. You can configure which Zulip 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 Zulip data and credentials are handled as safely as possible.

Used by agents from

Context
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai
Context
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai
Context
Letta
glean
HubSpot
Agent.ai
Altera
DataStax
Entelligence
Rolai

Never worry about agent reliability

We handle tool reliability, observability, and security so you never have to second-guess an agent action.

Book a call↗Get started for free