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
Channel Directory: Explore available channels 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 (19 Available Actions)

Message Operations

send-message - Send to channels or direct messages
get-messages - Retrieve with advanced filtering and search
upload-file - Share files and images
edit-message - Modify content or move topics
delete-message - Remove messages (admin permissions required)
get-message-read-receipts - Check who read messages
add-emoji-reaction - React with Unicode or custom emoji

Scheduled Messages & Drafts

create-scheduled-message - Schedule future messages
edit-scheduled-message - Modify scheduled messages
get-drafts - Retrieve saved drafts
edit-draft - Update draft content

Channel Management

get-subscribed-channels - List user's channel subscriptions
get-channel-id - Get channel ID by name
get-channel-by-id - Detailed channel information
get-topics-in-channel - Browse recent topics

User Operations

get-user-by-email - Find users by email
get-users - List organization members
update-status - Set status message and availability
get-user-groups - List available user groups

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:

git clone <repository-url>
cd zulip-mcp-server
npm install

Configure environment variables:

cp .env.example .env
# Edit .env with your Zulip credentials

Build and run:

npm run build
npm start

Environment Configuration

Create a .env file with your Zulip credentials:

ZULIP_URL=https://your-organization.zulipchat.com
ZULIP_EMAIL=your-bot-email@yourcompany.com
ZULIP_API_KEY=your-api-key-here
NODE_ENV=production

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:

{
  "mcpServers": {
    "zulip": {
      "command": "node",
      "args": ["/path/to/zulip-mcp-server/dist/server.js"],
      "env": {
        "ZULIP_URL": "https://your-organization.zulipchat.com",
        "ZULIP_EMAIL": "your-bot-email@yourcompany.com", 
        "ZULIP_API_KEY": "your-api-key-here"
      }
    }
  }
}

Option 2: Using .env File

If you prefer using a .env file, ensure it's in the project directory and use:

{
  "mcpServers": {
    "zulip": {
      "command": "node",
      "args": ["/path/to/zulip-mcp-server/dist/server.js"],
      "cwd": "/path/to/zulip-mcp-server"
    }
  }
}

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):

{
  "mcpServers": {
    "zulip": {
      "command": "node",
      "args": ["/path/to/zulip-mcp-server/dist/server.js"],
      "env": {
        "ZULIP_URL": "https://your-organization.zulipchat.com",
        "ZULIP_EMAIL": "your-bot-email@yourcompany.com",
        "ZULIP_API_KEY": "your-api-key-here"
      },
      "capabilities": {
        "tools": true,
        "resources": true
      }
    }
  }
}

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:

{
  "servers": {
    "zulip": {
      "name": "Zulip Integration",
      "description": "Send messages and interact with Zulip workspace",
      "command": "node",
      "args": ["/path/to/zulip-mcp-server/dist/server.js"],
      "env": {
        "ZULIP_URL": "https://your-organization.zulipchat.com",
        "ZULIP_EMAIL": "your-bot-email@yourcompany.com",
        "ZULIP_API_KEY": "your-api-key-here"
      },
      "icon": "💬",
      "categories": ["communication", "productivity"]
    }
  }
}

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:

node /path/to/zulip-mcp-server/dist/server.js

Development

Scripts

npm run dev          # Development with hot reload
npm run build        # Build for production
npm test            # Run tests
npm run lint        # Lint TypeScript
npm run typecheck   # Type checking

Project Structure

src/
├── server.ts        # Main MCP server
├── zulip/
│   └── client.ts    # Zulip API client
└── types.ts         # TypeScript definitions

Testing

Test the server using MCP Inspector:

npx @modelcontextprotocol/inspector npm start

Usage Examples

Sending Messages

// Send to a channel
await callTool("send-message", {
  type: "stream",
  to: "general",
  topic: "Daily Standup",
  content: "Good morning team! 👋\n\n**Today's Goals:**\n- Review PR #123\n- Deploy feature X"
});

// Direct message
await callTool("send-message", {
  type: "direct",
  to: "user@example.com",
  content: "Hey! Can you review the latest changes when you have a moment?"
});

Getting Messages

// Get recent messages from a channel
await callTool("get-messages", {
  narrow: [["stream", "general"], ["topic", "announcements"]],
  num_before: 50
});

// Search messages
await callTool("get-messages", {
  narrow: [["search", "deployment"], ["sender", "admin@example.com"]]
});

Channel Management

// List subscribed channels
await callTool("get-subscribed-channels", {
  include_subscribers: true
});

// Get channel topics
await callTool("get-topics-in-channel", {
  stream_id: 123
});

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)
Channel Links: #**channel-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

This server cannot be installed

security - not tested

license - not found

quality - not tested

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.

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

Azure DevOps MCP Server
Tiberriver256
A
security
A
license
A
quality
A 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 -
15
1,077
224
TypeScript
MIT License
MCP Personal Assistant Agent
zhangzhongnan928
-
security
F
license
-
quality
A 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 -
2
Python
Appwrite MCP Serverofficial
appwrite
A
security
A
license
A
quality
A 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 -
84
40
Python
MIT License
Zulip MCP Server
Monadical-SAS
-
security
A
license
-
quality
A 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 -
JavaScript
Apache 2.0

View all related MCP servers

Appeared in Searches

How to send a message on Slack

Zulip MCP Server

Features

🔄 Resources (Contextual Data)

🛠️ Tools (19 Available Actions)

Message Operations

Scheduled Messages & Drafts

Channel Management

User Operations

Installation & Setup

Prerequisites

Quick Start

Environment Configuration

Getting Zulip API Credentials

Claude Desktop Integration

Option 1: Using Environment Variables (Recommended)

Option 2: Using .env File

Cursor Integration

Cursor MCP Configuration

Raycast MCP Extension

Raycast MCP Configuration

Supported MCP Clients

Development

Scripts

Project Structure

Testing

Usage Examples

Sending Messages

Getting Messages

Channel Management

Markdown Formatting Support

Error Handling

Contributing

Support

Related MCP Servers

Azure DevOps MCP Server

MCP Personal Assistant Agent

Appwrite MCP Serverofficial

Zulip MCP Server

Appeared in Searches

New MCP Servers

MCP directory API