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>"
            }
        }
    }
}