The Zulip MCP Server enables programmatic interaction with a Zulip workspace, providing tools for AI assistants and applications to integrate with Zulip.
Key capabilities include:
- Message Operations: Send, edit, delete, and retrieve messages, add emoji reactions, upload files/images, check read receipts, and manage scheduled messages and drafts
- Stream Management: List subscribed streams, get stream information by ID/name, and browse topics within streams
- User Management: Search and retrieve user information, update status and availability
- Organization Features: Access user groups and organization information
- Formatting Support: Utilize Zulip's Markdown syntax including mentions and code blocks
The server is designed to integrate with MCP-compliant clients like Claude Desktop, Cursor IDE, and Raycast.
Compatible with Raycast MCP extension, enabling quick commands and automation for Zulip interactions directly from the Raycast interface.
Exposes Zulip REST API capabilities, allowing AI assistants to interact with Zulip workspaces through message operations (sending, retrieving, editing), channel management, user operations, and handling scheduled messages and drafts.
Zulip MCP Server
A Model Context Protocol (MCP) server that exposes Zulip REST API capabilities as tools for LLMs. This server allows AI assistants to interact with your Zulip workspace programmatically.
Features
🔄 Resources (Contextual Data)
- User Directory: Browse organization members with roles and status
- Stream Directory: Explore available streams and permissions
- Message Formatting Guide: Complete Zulip markdown syntax reference
- Organization Info: Server settings, policies, and custom emoji
- User Groups: Available groups for mentions and permissions
🛠️ Tools (25 Available Actions)
Helper Tools (LLM-Friendly Discovery)
search-users
- Find users by name/email before sending DMsget-started
- Test connection and get workspace overview
Message Operations
send-message
- Send to streams or direct messagesget-messages
- Retrieve with advanced filtering and searchget-message
- Get detailed information about specific messageupload-file
- Share files and imagesedit-message
- Modify content or move topicsdelete-message
- Remove messages (admin permissions required)get-message-read-receipts
- Check who read messagesadd-emoji-reaction
- React with Unicode or custom emojiremove-emoji-reaction
- Remove emoji reactions from messages
Scheduled Messages & Drafts
create-scheduled-message
- Schedule future messagesedit-scheduled-message
- Modify scheduled messagescreate-draft
- Create new message draftsget-drafts
- Retrieve saved draftsedit-draft
- Update draft content
Stream Management
get-subscribed-streams
- List user's stream subscriptionsget-stream-id
- Get stream ID by nameget-stream-by-id
- Detailed stream informationget-topics-in-stream
- Browse recent topics
User Operations
get-users
- List organization membersget-user-by-email
- Find users by emailget-user
- Get detailed user information by IDupdate-status
- Set status message and availabilityget-user-groups
- List available user groups
📝 Zulip Terminology: Streams vs Channels
In Zulip, "streams" and "channels" refer to the same concept:
- Stream = Official Zulip terminology (used in API, tools, interface)
- Channel = Common term from Slack/Discord/Teams
- Same thing = Conversation spaces where teams discuss topics
This MCP server uses "stream" to match Zulip's official documentation and API.
Installation & Setup
Prerequisites
- Node.js 18+ with npm
- TypeScript 5+
- Access to a Zulip instance (e.g., https://your-organization.zulipchat.com)
- Zulip API credentials (bot token or API key)
Quick Start
- Clone and install dependencies:
- Configure environment variables:
- Build and run:
Environment Configuration
Create a .env
file with your Zulip credentials:
Getting Zulip API Credentials
- For Bot Access (Recommended):
- Go to your Zulip organization settings
- Navigate to "Bots" section
- Create a new bot or use existing one
- Copy the bot email and API key
- For Personal Access:
- Go to Personal Settings → Account & Privacy
- Find "API key" section
- Generate or reveal your API key
Claude Desktop Integration
To use this MCP server with Claude Desktop, add the following configuration to your Claude Desktop config file:
Option 1: Using Environment Variables (Recommended)
Add to your Claude Desktop configuration:
Option 2: Using .env File
If you prefer using a .env
file, ensure it's in the project directory and use:
Claude Desktop Config Location:
- macOS:
~/Library/Application Support/Claude/claude_desktop_config.json
- Windows:
%APPDATA%\Claude\claude_desktop_config.json
Cursor Integration
To use this MCP server with Cursor IDE, add the following to your Cursor MCP settings:
Cursor MCP Configuration
Add to Cursor's MCP settings file (.cursor-mcp/config.json
in your workspace or global settings):
Cursor MCP Config Location:
- Workspace:
.cursor-mcp/config.json
in your project root - Global: Platform-specific Cursor settings directory
Raycast MCP Extension
To use this MCP server with Raycast, configure it in the MCP extension settings:
Raycast MCP Configuration
Add to Raycast MCP extension configuration:
Raycast Setup Steps:
- Install the Raycast MCP extension
- Open Raycast preferences → Extensions → MCP
- Add new server configuration
- Paste the JSON configuration above
- Update paths and credentials accordingly
Raycast Usage:
- Use
⌘ + Space
to open Raycast - Search for "Zulip" commands
- Execute MCP tools directly from Raycast interface
Supported MCP Clients
This server is compatible with any MCP-compliant client. Here are the verified integrations:
Platform | Config Type | Status | Usage |
---|---|---|---|
Claude Desktop | JSON config | ✅ Verified | AI conversations with Zulip integration |
Cursor IDE | Workspace/Global config | ✅ Verified | Code editor with Zulip notifications |
Raycast | Extension config | ✅ Verified | Quick commands and automation |
Other MCP Clients | Standard MCP protocol | 🔄 Compatible | Any MCP-compliant application |
Universal MCP Command:
Development
Scripts
Project Structure
Testing
Test the server using MCP Inspector:
Usage Examples
Sending Messages
Getting Messages
Stream Management
Markdown Formatting Support
The server includes a comprehensive formatting guide resource. Zulip supports:
- Standard Markdown: Bold, italic, code, links, lists
- Mentions:
@**Full Name**
(notify),@_**Name**_
(silent) - Stream Links:
#**stream-name**
- Code Blocks: With syntax highlighting
- Math: LaTeX expressions with
$$math$$
- Spoilers:
||hidden content||
- Custom Emoji: Organization-specific emoji
Error Handling
The server provides comprehensive error handling:
- Network connectivity issues
- Authentication failures
- Permission errors
- Rate limiting
- Invalid parameters
- Zulip API errors
All errors include helpful messages for debugging.
Contributing
- Fork the repository
- Create a feature branch
- Add tests for new functionality
- Ensure TypeScript compilation passes
- Submit a pull request
Support
For issues and questions:
- Check Zulip API documentation: https://zulip.com/api/
- Review MCP specification: https://modelcontextprotocol.io/
- Open GitHub issues for bugs or feature requests
remote-capable server
The server can be hosted and run remotely because it primarily relies on remote services or has no dependency on the local environment.
Tools
A Model Context Protocol server that enables AI assistants to interact with Zulip workspaces by exposing REST API capabilities as tools for message operations, channel management, and user interactions.
Related MCP Servers
- AsecurityAlicenseAqualityA Model Context Protocol server that enables AI assistants to interact with Azure DevOps resources including projects, work items, repositories, pull requests, branches, and pipelines through a standardized protocol.Last updated -151,195264TypeScriptMIT License
- -securityFlicense-qualityA versatile Model Context Protocol server that enables AI assistants to manage calendars, track tasks, handle emails, search the web, and control smart home devices.Last updated -2Python
Appwrite MCP Serverofficial
AsecurityAlicenseAqualityA Model Context Protocol server that allows AI assistants to interact with Appwrite's API, providing tools to manage databases, users, functions, teams, and other resources within Appwrite projects.Last updated -8440PythonMIT License- -securityAlicense-qualityA Model Context Protocol server that enables AI assistants like Claude to interact with Zulip workspaces, supporting capabilities such as posting messages, listing channels, sending direct messages, and accessing conversation history.Last updated -JavaScriptApache 2.0