How to integrate Zulip MCP with LlamaIndex

GET STARTED FOR FREE
Framework Integration Gradient
Zulip Logo
LlamaIndex Logo
divider

Introduction

This guide walks you through connecting Zulip to LlamaIndex 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 LlamaIndex 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:
  • Set your OpenAI and Composio API keys
  • Install LlamaIndex and Composio packages
  • Create a Composio Tool Router session for Zulip
  • Connect LlamaIndex to the Zulip MCP server
  • Build a Zulip-powered agent using LlamaIndex
  • Interact with Zulip through natural language

What is LlamaIndex?

LlamaIndex is a data framework for building LLM applications. It provides tools for connecting LLMs to external data sources and services through agents and tools.

Key features include:

  • ReAct Agent: Reasoning and acting pattern for tool-using agents
  • MCP Tools: Native support for Model Context Protocol
  • Context Management: Maintain conversation context across interactions
  • Async Support: Built 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 you begin, make sure you have:
  • Python 3.8/Node 16 or higher installed
  • A Composio account with the API key
  • An OpenAI API key
  • A Zulip account and project
  • Basic familiarity with async Python/Typescript

Getting API Keys for OpenAI, Composio, and Zulip

OpenAI API key (OPENAI_API_KEY)
  • Go to the OpenAI dashboard
  • Create an API key if you don't have one
  • Assign it to OPENAI_API_KEY in .env
Composio API key and user ID
  • Log into the Composio dashboard
  • Copy your API key from Settings
    • Use this as COMPOSIO_API_KEY
  • Pick a stable user identifier (email or ID)
    • Use this as COMPOSIO_USER_ID

Installing dependencies

pip install composio-llamaindex llama-index llama-index-llms-openai llama-index-tools-mcp python-dotenv

Create a new Python project and install the necessary dependencies:

  • composio-llamaindex: Composio's LlamaIndex integration
  • llama-index: Core LlamaIndex framework
  • llama-index-llms-openai: OpenAI LLM integration
  • llama-index-tools-mcp: MCP client for LlamaIndex
  • python-dotenv: Environment variable management

Set environment variables

bash
OPENAI_API_KEY=your-openai-api-key
COMPOSIO_API_KEY=your-composio-api-key
COMPOSIO_USER_ID=your-user-id

Create a .env file in your project root:

These credentials will be used to:

  • Authenticate with OpenAI's GPT-5 model
  • Connect to Composio's Tool Router
  • Identify your Composio user session for Zulip access

Import modules

import asyncio
import os
import dotenv

from composio import Composio
from composio_llamaindex import LlamaIndexProvider
from llama_index.core.agent.workflow import ReActAgent
from llama_index.core.workflow import Context
from llama_index.llms.openai import OpenAI
from llama_index.tools.mcp import BasicMCPClient, McpToolSpec

dotenv.load_dotenv()

Create a new file called zulip_llamaindex_agent.py and import the required modules:

Key imports:

  • asyncio: For async/await support
  • Composio: Main client for Composio services
  • LlamaIndexProvider: Adapts Composio tools for LlamaIndex
  • ReActAgent: LlamaIndex's reasoning and action agent
  • BasicMCPClient: Connects to MCP endpoints
  • McpToolSpec: Converts MCP tools to LlamaIndex format

Load environment variables and initialize Composio

OPENAI_API_KEY = os.getenv("OPENAI_API_KEY")
COMPOSIO_API_KEY = os.getenv("COMPOSIO_API_KEY")
COMPOSIO_USER_ID = os.getenv("COMPOSIO_USER_ID")

if not OPENAI_API_KEY:
    raise ValueError("OPENAI_API_KEY is not set in the environment")
if not COMPOSIO_API_KEY:
    raise ValueError("COMPOSIO_API_KEY is not set in the environment")
if not COMPOSIO_USER_ID:
    raise ValueError("COMPOSIO_USER_ID is not set in the environment")

What's happening:

This ensures missing credentials cause early, clear errors before the agent attempts to initialise.

Create a Tool Router session and build the agent function

async def build_agent() -> ReActAgent:
    composio_client = Composio(
        api_key=COMPOSIO_API_KEY,
        provider=LlamaIndexProvider(),
    )

    session = composio_client.create(
        user_id=COMPOSIO_USER_ID,
        toolkits=["zulip"],
    )

    mcp_url = session.mcp.url
    print(f"Composio MCP URL: {mcp_url}")

    mcp_client = BasicMCPClient(mcp_url, headers={"x-api-key": COMPOSIO_API_KEY})
    mcp_tool_spec = McpToolSpec(client=mcp_client)
    tools = await mcp_tool_spec.to_tool_list_async()

    llm = OpenAI(model="gpt-5")

    description = "An agent that uses Composio Tool Router MCP tools to perform Zulip actions."
    system_prompt = """
    You are a helpful assistant connected to Composio Tool Router.
    Use the available tools to answer user queries and perform Zulip actions.
    """
    return ReActAgent(tools=tools, llm=llm, description=description, system_prompt=system_prompt, verbose=True)

What's happening here:

  • We create a Composio client using your API key and configure it with the LlamaIndex provider
  • We then create a tool router MCP session for your user, specifying the toolkits we want to use (in this case, zulip)
  • The session returns an MCP HTTP endpoint URL that acts as a gateway to all your configured tools
  • LlamaIndex will connect to this endpoint to dynamically discover and use the available Zulip tools.
  • The MCP tools are mapped to LlamaIndex-compatible tools and plug them into the Agent.

Create an interactive chat loop

async def chat_loop(agent: ReActAgent) -> None:
    ctx = Context(agent)
    print("Type 'quit', 'exit', or Ctrl+C to stop.")

    while True:
        try:
            user_input = input("\nYou: ").strip()
        except (KeyboardInterrupt, EOFError):
            print("\nBye!")
            break

        if not user_input or user_input.lower() in {"quit", "exit"}:
            print("Bye!")
            break

        try:
            print("Agent: ", end="", flush=True)
            handler = agent.run(user_input, ctx=ctx)

            async for event in handler.stream_events():
                # Stream token-by-token from LLM responses
                if hasattr(event, "delta") and event.delta:
                    print(event.delta, end="", flush=True)
                # Show tool calls as they happen
                elif hasattr(event, "tool_name"):
                    print(f"\n[Using tool: {event.tool_name}]", flush=True)

            # Get final response
            response = await handler
            print()  # Newline after streaming
        except KeyboardInterrupt:
            print("\n[Interrupted]")
            continue
        except Exception as e:
            print(f"\nError: {e}")

What's happening here:

  • We're creating a direct terminal interface to chat with your Zulip database
  • The LLM's responses are streamed to the CLI for faster interaction.
  • The agent uses context to maintain conversation history
  • You can type 'quit' or 'exit' to stop the chat loop gracefully
  • Agent responses and any errors are displayed in a clear, readable format

Define the main entry point

async def main() -> None:
    agent = await build_agent()
    await chat_loop(agent)

if __name__ == "__main__":
    # Handle Ctrl+C gracefully
    signal.signal(signal.SIGINT, lambda s, f: (print("\nBye!"), exit(0)))
    try:
        asyncio.run(main())
    except KeyboardInterrupt:
        print("\nBye!")

What's happening here:

  • We're orchestrating the entire application flow
  • The agent gets built with proper error handling
  • Then we kick off the interactive chat loop so you can start talking to Zulip

Run the agent

npx ts-node llamaindex-agent.ts

When prompted, authenticate and authorise your agent with Zulip, then start asking questions.

Complete Code

Here's the complete code to get you started with Zulip and LlamaIndex:

import asyncio
import os
import signal
import dotenv

from composio import Composio
from composio_llamaindex import LlamaIndexProvider
from llama_index.core.agent.workflow import ReActAgent
from llama_index.core.workflow import Context
from llama_index.llms.openai import OpenAI
from llama_index.tools.mcp import BasicMCPClient, McpToolSpec

dotenv.load_dotenv()

OPENAI_API_KEY = os.getenv("OPENAI_API_KEY")
COMPOSIO_API_KEY = os.getenv("COMPOSIO_API_KEY")
COMPOSIO_USER_ID = os.getenv("COMPOSIO_USER_ID")

if not OPENAI_API_KEY:
    raise ValueError("OPENAI_API_KEY is not set")
if not COMPOSIO_API_KEY:
    raise ValueError("COMPOSIO_API_KEY is not set")
if not COMPOSIO_USER_ID:
    raise ValueError("COMPOSIO_USER_ID is not set")

async def build_agent() -> ReActAgent:
    composio_client = Composio(
        api_key=COMPOSIO_API_KEY,
        provider=LlamaIndexProvider(),
    )

    session = composio_client.create(
        user_id=COMPOSIO_USER_ID,
        toolkits=["zulip"],
    )

    mcp_url = session.mcp.url
    print(f"Composio MCP URL: {mcp_url}")

    mcp_client = BasicMCPClient(mcp_url, headers={"x-api-key": COMPOSIO_API_KEY})
    mcp_tool_spec = McpToolSpec(client=mcp_client)
    tools = await mcp_tool_spec.to_tool_list_async()

    llm = OpenAI(model="gpt-5")
    description = "An agent that uses Composio Tool Router MCP tools to perform Zulip actions."
    system_prompt = """
    You are a helpful assistant connected to Composio Tool Router.
    Use the available tools to answer user queries and perform Zulip actions.
    """
    return ReActAgent(
        tools=tools,
        llm=llm,
        description=description,
        system_prompt=system_prompt,
        verbose=True,
    );

async def chat_loop(agent: ReActAgent) -> None:
    ctx = Context(agent)
    print("Type 'quit', 'exit', or Ctrl+C to stop.")

    while True:
        try:
            user_input = input("\nYou: ").strip()
        except (KeyboardInterrupt, EOFError):
            print("\nBye!")
            break

        if not user_input or user_input.lower() in {"quit", "exit"}:
            print("Bye!")
            break

        try:
            print("Agent: ", end="", flush=True)
            handler = agent.run(user_input, ctx=ctx)

            async for event in handler.stream_events():
                # Stream token-by-token from LLM responses
                if hasattr(event, "delta") and event.delta:
                    print(event.delta, end="", flush=True)
                # Show tool calls as they happen
                elif hasattr(event, "tool_name"):
                    print(f"\n[Using tool: {event.tool_name}]", flush=True)

            # Get final response
            response = await handler
            print()  # Newline after streaming
        except KeyboardInterrupt:
            print("\n[Interrupted]")
            continue
        except Exception as e:
            print(f"\nError: {e}")

async def main() -> None:
    agent = await build_agent()
    await chat_loop(agent)

if __name__ == "__main__":
    # Handle Ctrl+C gracefully
    signal.signal(signal.SIGINT, lambda s, f: (print("\nBye!"), exit(0)))
    try:
        asyncio.run(main())
    except KeyboardInterrupt:
        print("\nBye!")

Conclusion

You've successfully connected Zulip to LlamaIndex through Composio's Tool Router MCP layer. Key takeaways:
  • Tool Router dynamically exposes Zulip tools through an MCP endpoint
  • LlamaIndex's ReActAgent handles reasoning and orchestration; Composio handles integrations
  • The agent becomes more capable without increasing prompt size
  • Async Python provides clean, efficient execution of agent workflows
You can easily extend this to other toolkits like Gmail, Notion, Stripe, GitHub, and more by adding them to the toolkits parameter.

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

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 LlamaIndex?

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