Zulip API服务器

Zulip MCP服务器是一个支持AI助手与Zulip工作空间交互的API服务,提供频道管理、消息发送、用户交互等功能。

  • by Monadical-SAS
  • JavaScript
  • 本地部署
  • 12 星标
  • 更新于
在 GitHub 查看 Monadical-SAS/zulip-mcp

使用说明

Zulip MCP服务器

用于Zulip API的MCP服务器,使Claude等人工智能助手能够与Zulip工作空间进行交互。

工具

  1. zulip_list_channels

    • 列出Zulip组织中的可用频道(流)
    • 可选输入:
      • include_private (boolean,默认值:false):是否包含私有流
      • include_web_public (boolean,默认值:true):是否包含web公共流
      • include_subscribed (boolean,默认值:true):是否包含机器人订阅的流
    • 返回:流及其ID和信息的列表
  2. zulip_post_message

    • 将新消息发布到Zulip频道(流媒体)
    • 所需输入:
      • channel_name (string):要发布到的流的名称
      • topic (string):流中的主题
      • content (string):要发布的消息内容
    • 返回:消息发布确认和ID
  3. zulip_send_direct_message

    • 向一个或多个用户发送直接消息
    • 所需输入:
      • recipients (string[]):收件人的电子邮件地址或用户ID
      • content (string):要发送的消息内容
    • 返回:消息发送确认和ID
  4. zulip_add_reaction

    • 在消息中添加表情符号反应
    • 所需输入:
      • message_id (number):要响应的消息的ID
      • emoji_name (字符串):不带冒号的表情符号名称
    • 返回:反应确认
  5. zulip_get_channel_history

    • 从频道(流)和主题获取最新消息
    • 所需输入:
      • channel_name (string):流的名称
      • topic (string):主题名称
    • 可选输入:
      • limit (数字,默认值:20):要检索的邮件数
      • anchor (字符串,默认值:“最新”):消息ID从开始
    • 返回:消息及其内容和元数据的列表
  6. zulip_get_topics

    • 获取频道(流)中的主题
    • 所需输入:
      • channel_id (number):流的ID
    • 返回:流中的主题列表
  7. zulip_subscribe_to_channel

    • 将机器人订阅到频道(流)
    • 所需输入:
      • channel_name (string):要订阅的流的名称
    • 返回:订阅确认
  8. zulip_get_users

    • 获取Zulip组织中的用户列表
    • 返回:用户列表及其基本信息

设置

  1. 创建Zulip Bot:

    • 登录您的Zulip实例
    • 导航到“设置”>“个人”>“机器人”
    • 点击“添加新机器人”
    • 选择“通用机器人”类型
    • 填写所需信息
    • 点击“创建机器人”
  2. 权限:

    • 默认情况下,Zulip机器人的权限有限
    • 确保将机器人订阅到它需要访问的任何流
    • 如果您需要机器人拥有更多权限,请考虑使用完整用户帐户
  3. 获取API凭据:

    • Bot的电子邮件地址
    • 机器人程序的API密钥(创建机器人程序时显示)
    • Zulip实例URL(例如。,https://example.zulipchat.com)

使用Claude Desktop

将以下内容添加到您的 claude_desktop_config.json:

新巴拿马型船舶

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

码头工人

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

故障排除

如果遇到权限错误,请验证:

  1. 机器人程序API密钥正确
  2. 机器人已订阅了它需要访问的频道
  3. Zulip URL正确且可访问

构建

Docker构建:

docker build -t mcp/zulip .

许可证

版权所有2025 Monadical

根据Apache许可证2.0版(“许可证”)许可; 除非遵守许可证,否则您不得使用此文件。 您可以在以下网址获得许可证副本

http://www.apache.org/licenses/LICENSE-2.0

除非适用法律要求或书面同意,否则软件 根据许可证分发的内容按“原样”分发, 无任何明示或暗示的保证或条件。 请参阅许可证,了解管理权限和 许可证下的限制。

本产品包括第三方软件组件。看 许可证 和 通知 文件以获取详细信息。