金大哥 - Zulip MCP 详情

article

README

🚀 Zulip MCP 服务器

Zulip 的 MCP（机器上下文协议）服务器为 Zulip API 提供支持，让 AI 助手（如 Claude）能够与 Zulip 工作区进行交互，增强了工作区的智能化和自动化能力。

✨ 主要特性

Zulip MCP 服务器提供了一系列实用工具，方便与 Zulip 进行交互：

zulip_list_channels：列出组织中的可用频道（流）。可通过可选参数 include_private（是否包含私有流）、include_web_public（是否包含对网页公开的流）、include_subscribed（是否包含机器人已订阅的流）来定制输出，最终返回包含 ID 和信息的流列表。
zulip_post_message：向 Zulip 频道（流）发布新消息。需要提供 channel_name（流名称）、topic（流中的主题）、content（消息内容）这些必需输入，操作完成后返回消息发布确认和 ID。
zulip_send_direct_message：向一个或多个用户发送直接消息。必需输入为 recipients（收件人的电子邮件地址或用户 ID）和 content（消息内容），返回消息发送确认和 ID。
zulip_add_reaction：在某条消息上添加表情符号反应。需提供 message_id（要回复的消息 ID）和 emoji_name（无冒号的表情符号名称），返回反应确认。
zulip_get_channel_history：从频道（流）和主题获取最近消息。必需输入 channel_name（流的名称）和 topic（主题名称），还可通过可选参数 limit（要检索的消息数量，默认 20）和 anchor（起始点消息 ID，默认 "newest"）来定制，最终返回包含内容和元数据的消息列表。
zulip_get_topics：获取频道（流）中的主题列表，只需提供 channel_name（流的名称），返回反应确认。
zulip_join_channel：加入一个频道，提供 channel_name（要加入的流名称）后返回加入频道确认。
zulip_leave_channel：退出一个频道，提供 channel_name（要退出的流名称）后返回退出频道确认。

📦 安装指南

创建 Zulip 机器人

登录您的 Zulip 组织。
访问 Zulip 管理页面。
点击“创建新机器人”按钮。
配置机器人设置，如机器人名称和邮件地址。
生成并记录 API 密钥。

配置权限

确保机器人具备以下权限：

读取权限：允许机器人查看频道内容。
写入权限：允许机器人发送消息。
管理权限（可选）：允许机器人管理其他用户或频道。

💻 使用示例

与 Claude Desktop 集成

使用 npx 运行

在终端中运行以下命令：

npx mcp-server zulip --url YOUR_ZULIP_URL --token YOUR_API_KEY

使用 Docker 运行

构建镜像并运行容器：

docker build -t mcp/zulip .
docker run -it --rm mcp/zulip --url YOUR_ZULIP_URL --token YOUR_API_KEY

配置示例

npx 方法

编辑 claude_desktop_config.json 文件，添加以下内容：

{
  "mcpServers": [
    {
      "command": "npx",
      "args": ["mcp-server", "zulip"],
      "env": {
        "ZULIP_URL": "https://your-org.zulip.com",
        "ZULIP_TOKEN": "your_api_key_here"
      }
    }
  ]
}

Docker 方法

编辑 claude_desktop_config.json 文件，添加以下内容：

{
  "mcpServers": [
    {
      "command": "docker",
      "args": ["run", "-it", "--rm", "mcp/zulip"],
      "env": {
        "ZULIP_URL": "https://your-org.zulip.com",
        "ZULIP_TOKEN": "your_api_key_here"
      }
    }
  ]
}

📚 详细文档

故障排除

遇到权限错误时，请检查：

确保 API 密钥正确无误。
确认机器人已订阅需要访问的频道。
确保 Zulip URL 正确且可访问。

构建

使用以下命令构建 Docker 镜像：

docker build -t mcp/zulip .

📄 许可证

此 MCP 服务器在 MIT 许可证下发行。

Zulip