Zulip

🚀 Zulip MCP 服務器

Zulip 的 MCP（機器上下文協議）服務器為 Zulip API 提供支持，讓 AI 助手（如 Claude）能夠與 Zulip 工作區進行交互。

✨ 主要特性

本項目提供了一系列工具，可實現與 Zulip 工作區的多種交互功能，具體如下：

1. zulip_list_channels：列出組織中的可用頻道（流）。可通過可選參數控制是否包含私有流、對網頁公開的流以及機器人已訂閱的流，返回包含 ID 和信息的流列表。
2. zulip_post_message：向 Zulip 頻道（流）發佈新消息，需指定流名稱、流中的主題和消息內容，返回確認消息發佈和 ID。
3. zulip_send_direct_message：向一個或多個用戶發送直接消息，需提供收件人的電子郵件地址或用戶 ID 以及消息內容，返回確認消息發送和 ID。
4. zulip_add_reaction：在某條消息上添加表情符號反應，需指定要回復的消息 ID 和無冒號的表情符號名稱，返回確認反應。
5. zulip_get_channel_history：從頻道（流）和主題獲取最近消息，可通過可選參數控制檢索的消息數量和起始點消息 ID，返回包含內容和元數據的消息列表。
6. zulip_get_topics：獲取頻道（流）中的主題列表，需指定流的名稱，返回確認反應。
7. zulip_join_channel：加入一個頻道，需指定要加入的流名稱，返回確認加入頻道。
8. zulip_leave_channel：退出一個頻道，需指定要退出的流名稱，返回確認退出頻道。

📦 安裝指南

創建 Zulip 機器人

1. 登錄您的 Zulip 組織。
2. 訪問 Zulip 管理 頁面。
3. 點擊“創建新機器人”按鈕。
4. 配置機器人設置，如機器人名稱和郵件地址。
5. 生成並記錄 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"
      }
    }
  ]
}

📚 詳細文檔

故障排除

遇到權限錯誤時，請檢查：

1. 確保 API 密鑰正確無誤。
2. 確認機器人已訂閱需要訪問的頻道。
3. 確保 Zulip URL 正確且可訪問。

構建

使用以下命令構建 Docker 鏡像：

docker build -t mcp/zulip .

📄 許可證

此 MCP 服務器在 MIT 許可證下發行。