Zulip MCP Server

Zulip MCP Server

site icon
2025.03.11 1
JavaScript团队协作自动化消息处理交流协作
Zulip MCP Server 是一个为 Zulip API 设计的 MCP 服务器,使 AI 助手(如 Claude)能够与 Zulip 工作区进行交互。它提供了一系列工具,用于管理频道、发送消息、获取历史记录等,适用于团队协作和自动化消息处理场景。
View on GitHub

Overview

基本能力

产品定位

Zulip MCP Server 是一个中间件服务,旨在连接 AI 助手与 Zulip 协作平台,实现自动化消息处理和团队协作功能。

核心功能

  1. 频道管理:列出、订阅和管理 Zulip 频道(streams)。
  2. 消息发送:支持在频道中发布消息、发送私信以及添加表情反应。
  3. 历史记录查询:获取频道和话题的历史消息记录。
  4. 用户管理:获取组织内的用户列表。

适用场景

  • 团队协作自动化
  • AI 助手集成到 Zulip 工作区
  • 自动化消息处理和通知

工具列表

  1. zulip_list_channels:列出 Zulip 组织中的可用频道。
  2. zulip_post_message:在指定频道发布消息。
  3. zulip_send_direct_message:发送私信给一个或多个用户。
  4. zulip_add_reaction:给消息添加表情反应。
  5. zulip_get_channel_history:获取频道的最近消息。
  6. zulip_get_topics:获取频道中的话题列表。
  7. zulip_subscribe_to_channel:订阅机器人到指定频道。
  8. zulip_get_users:获取组织内的用户列表。

常见问题解答

  • 权限错误:检查 API 密钥是否正确,机器人是否已订阅所需频道,Zulip URL 是否正确且可访问。

使用教程

使用依赖

  1. 需要一个 Zulip 实例和有效的机器人账号。
  2. 确保已安装 Node.js 或 Docker(根据安装方式选择)。

安装教程

使用 npx

{
  "mcpServers": {
    "zulip": {
      "command": "npx",
      "args": [
        "-y",
        "@modelcontextprotocol/server-zulip"
      ],
      "env": {
        "ZULIP_EMAIL": "[email protected]",
        "ZULIP_API_KEY": "your-bot-api-key",
        "ZULIP_URL": "https://example.zulipchat.com"
      }
    }
  }
}

使用 Docker

{
  "mcpServers": {
    "zulip": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "ZULIP_EMAIL",
        "-e",
        "ZULIP_API_KEY",
        "-e",
        "ZULIP_URL",
        "mcp/zulip"
      ],
      "env": {
        "ZULIP_EMAIL": "[email protected]",
        "ZULIP_API_KEY": "your-bot-api-key",
        "ZULIP_URL": "https://example.zulipchat.com"
      }
    }
  }
}

调试方式

  1. 确保环境变量 ZULIP_EMAILZULIP_API_KEYZULIP_URL 已正确设置。
  2. 检查机器人是否有权限访问所需频道。
  3. 使用日志功能查看错误信息。

构建

docker build -t mcp/zulip .

许可证

该项目遵循 Apache-2.0 开源许可条款,请参阅 Apache-2.0 了解完整条款。