Zulip MCP 服务器使用说明

项目简介

zulip-mcp 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在弥合大型语言模型（LLM）与 Zulip 协作平台之间的鸿沟。通过 zulip-mcp，LLM 驱动的智能助手可以安全地访问和操作 Zulip 工作空间内的信息，实现自动化消息发送、信息检索、用户管理等功能，从而提升团队协作效率和智能化水平。

主要功能点

列出频道 (zulip_list_channels): 检索 Zulip 组织中可用的频道列表，支持筛选私有频道和公开频道。
发送消息 (zulip_post_message): 在指定的 Zulip 频道和话题下发布新消息。
发送私信 (zulip_send_direct_message): 向一个或多个 Zulip 用户发送直接消息。
添加 reaction (zulip_add_reaction): 给指定的 Zulip 消息添加 emoji 表情符号反应。
获取频道历史 (zulip_get_channel_history): 获取指定 Zulip 频道和话题的最近消息记录。
获取话题列表 (zulip_get_topics): 获取指定 Zulip 频道中的所有话题列表。
订阅频道 (zulip_subscribe_to_channel): 让机器人账号订阅指定的 Zulip 频道。
获取用户列表 (zulip_get_users): 获取 Zulip 组织中的所有用户列表。

安装步骤

创建 Zulip Bot 机器人账号:
- 登录您的 Zulip 工作空间。
- 进入 "Settings" (设置) -> "Personal" (个人) -> "Bots" (机器人)。
- 点击 "Add a new bot" (添加新机器人)。
- 选择 "Generic bot" (通用机器人) 类型。
- 填写机器人所需的信息（名称、描述等）。
- 点击 "Create bot" (创建机器人)。
配置机器人权限:
- 默认情况下，Zulip 机器人权限受限。
- 确保将机器人订阅到它需要访问的频道。
- 如果需要更高权限，请考虑使用完整的用户账号而非机器人账号。
获取 API 凭据:
- 机器人的邮箱地址 (Bot's email address)。
- 机器人的 API 密钥 (Bot's API key，创建机器人时显示)。
- Zulip 工作空间的 URL (Zulip instance URL)，例如 'https://your-zulip-instance.zulipchat.com'。

服务器配置

以下 JSON 配置信息用于 MCP 客户端（如 Claude Desktop）连接 zulip-mcp 服务器。您需要根据实际情况修改 'env' 中的配置参数。

{
  "mcpServers": {
    "zulip": {
      "command": "npx",
      "args": [
        "-y",
        "@modelcontextprotocol/server-zulip"
      ],
      "env": {
        "ZULIP_EMAIL": "[email protected]",  // 替换为您的 Zulip 机器人邮箱地址
        "ZULIP_API_KEY": "your-bot-api-key",           // 替换为您的 Zulip 机器人 API ��钥
        "ZULIP_URL": "https://example.zulipchat.com"    // 替换为您的 Zulip 工作空间 URL
      }
    }
  }
}

如果您使用 Docker 运行 zulip-mcp 服务器，请使用以下配置：

{
  "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 机器人邮箱地址
        "ZULIP_API_KEY": "your-bot-api-key",           // 替换为您的 Zulip 机器人 API 密钥
        "ZULIP_URL": "https://example.zulipchat.com"    // 替换为您的 Zulip 工作空间 URL
      }
    }
  }
}

基本使用方法

确保已安装 Node.js 和 Docker (如果选择 Docker 方式运行)。
根据 "安装步骤" 创建 Zulip 机器人账号并获取 API 凭据。
将上述服务器配置 JSON 添加到 MCP 客户端的配置文件中 (例如 'claude_desktop_config.json')，并替换 'env' 中的占位符信息为您的 Zulip 机器人账号凭据和工作空间 URL。
启动 MCP 客户端，客户端将自动连接到 zulip-mcp 服务器。
在 MCP 客户端中，您可以使用 'zulip_list_channels', 'zulip_post_message' 等工具与 Zulip 工作空间进行交互。具体工具的使用方法请参考工具的描述信息。

注意: 首次使用 'npx' 方式运行时，可能会需要下载 '@modelcontextprotocol/server-zulip' 包，请耐心等待。

关键词