Zammad MCP Go

🚀 Zammad-go-mcp 服務

Zammad-go-mcp 服務用於訪問 Zammad 的 API，可實現以下核心功能：

• 讀取票務和用戶列表。
• 獲取特定票務和用戶的詳細信息。
• 搜索票務和用戶。
• 創建新票務。
• 向現有票務添加備註（文章）。
• 獲取票務的溝通曆史記錄（文章）。

🚀 快速開始

✨ 主要特性

該服務器公開了以下 MCP 資源和工具：

資源

資源允許 AI 通過 URI 從 Zammad 中以結構化方式讀取數據。

• zammad://tickets
  • 名稱：列出票務
  • 描述：列出 API 令牌可訪問的所有票務。
  • MIME 類型：application/json
• zammad://tickets/{ticket_id}（模板）
  • 名稱：顯示票務（資源）
  • 描述：顯示特定票務的詳細信息，該票務由其 {ticket_id} 標識。
  • MIME 類型：application/json
• zammad://users
  • 名稱：列出用戶
  • 描述：列出 API 令牌可訪問的所有用戶。
  • MIME 類型：application/json
• zammad://users/{user_id}（模板）
  • 名稱：顯示用戶（資源）
  • 描述：顯示特定用戶的詳細信息，該用戶由其 {user_id} 標識。
  • MIME 類型：application/json

工具

工具允許 AI 在 Zammad 中執行操作或特定查詢。

• create_ticket：在 Zammad 中創建新票務。
  • 必需參數：title、group、customer（電子郵件或用戶 ID）、body。
  • 可選參數：tags、priority、status。
• get_ticket：獲取特定票務的詳細信息。
  • 必需參數：ticket_id。
• search_tickets：搜索符合條件的票務。
  • 接受過濾條件：例如 tag、priority、status。
• add_comment：向票務添加備註。
  • 必需參數：ticket_id、comment。
• search_users：搜索用戶。
  • 接受過濾條件：例如 email、name。

📦 安裝指南

先決條件

系統要求

• 操作系統：Windows、Linux、macOS
• 內存：至少 512MB
• 處理器：任意現代處理器

安裝依賴項

確保以下庫已安裝：

• Go：版本 1.20 或更高。
• Git：用於克隆倉庫。

獲取 Zammad API 令牌

要使用該服務，您需要獲取具有適當權限的 Zammad API 令牌，步驟如下：

1. 登錄到 Zammad 系統。
2. 進入“ administer → User”菜單。
3. 導航至“API tokens”部分。
4. 創建新令牌並授予以下權限：
   • view tickets
   • create ticket
   • update ticket
   • delete ticket

安裝與設置

克隆倉庫

使用 Git 克隆項目倉庫：

git clone https://github.com/your-username/zammad-go-mcp.git

構建二進制文件

在項目的根目錄中，運行以下命令構建可執行文件：

go build -o zammad-mcp-go main.go

這將生成一個名為 zammad-mcp-go 的可執行文件（或 zammad-mcp-go.exe 在 Windows 上）。

配置環境變量

在運行服務之前，設置以下環境變量：

• ZAMMAD_URL：Zammad 實例的 URL，例如 https://your-zammad-instance.com。
• ZAMMAD_TOKEN：您創建的 API 令牌。

Claude Desktop 配置示例

{
  "mcpServers": {
        "zammad": {
            "command": "<path-to>/zammad-go-mcp.exe",
            "args": [],
            "env": {
                "ZAMMAD_URL": "<zammad_url>",
                "ZAMMAD_TOKEN": "<zammad_token>"
            }
        }
    }
}