Zammad API访问服务

一个用于访问Zammad API的MCP服务器,支持读取票证和用户列表、搜索、创建票证及添加注释等功能。

  • by arush15june
  • Go
  • 本地部署
  • 11 星标
  • 更新于
在 GitHub 查看 arush15june/zammad-mcp-go

使用说明

赞比亚人go mcp

用于访问Zammad API的MCP服务器。

此服务器支持:

  • 正在读取工单和用户列表。
  • 获取特定门票和用户的详细信息。
  • 搜索门票和用户。
  • 创建新票。
  • 在现有票上添加注释(文章)。
  • 正在检索票证的通信历史记录(文章)。

能力

服务器公开了以下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.
    • 可选: type (文章类型,默认:“注释”), internal (布尔值,默认值:false)。
  • search_tickets:根据查询字符串搜索门票。
    • 要求: query.
    • 可选: limit (默认值:50)。
  • add_note_to_ticket:向现有票证添加内部注释(文章)。
    • 要求: ticket_id, body.
    • 可选: internal (布尔值,默认值:true)。
  • get_ticket:通过特定票证的ID检索其详细信息。
    • 要求: ticket_id.
  • get_user:通过特定用户的ID检索其详细信息。
    • 要求: user_id.
  • search_users:根据查询字符串(例如电子邮件、登录名、姓名)搜索用户。
    • 要求: query.
    • 可选: limit (默认值:50)。
  • get_ticket_articles:检索特定票证的所有文章(通信)。
    • 要求: ticket_id.

先决条件

  • 去: 已安装1.24或更高版本。
  • Zammad实例: 访问正在运行的Zammad实例(URL)。
  • Zammad API代币: 在具有足够权限的Zammad实例中生成的API令牌。

获取Zammad API代币

您需要在Zammad中生成一个API令牌,以允许此MCP服务器验证API并与之交互。

  1. 登录 使用管理员帐户(或具有管理API令牌权限的帐户)将您的Zammad实例添加到Zammad。
  2. 导航到您的 个人资料 设置(通常通过单击左下角的头像/首字母)。
  3. 转到 令牌访问 部分。
  4. 点击 “创建” 或点击相关按钮以生成新令牌。
  5. 给令牌一个描述性的 标签 (例如“克劳德MCP服务器”)。
  6. 至关重要的是,分配必要的权限。 根据提供的工具,您可能需要以下权限:
    • ticket.agent (或 ticket.customer 取决于用例)-查看、创建、搜索工单和添加文章。
    • user.reader -查看和搜索用户。
    • (可选) admin.user 如果以后添加这些工具,可能需要更广泛的用户搜索或修改。查看Zammad的许可文件以了解详细信息。
  7. 点击 “创建” 或 “保存”.
  8. 立即复制生成的令牌。 Zammad只会给你看代币 一次请妥善保管。

安装和设置

  1. 克隆存储库:

    git clone https://github.com/arush15june/zammad-mcp-go.git
    cd zammad-mcp-go
    
  2. 构建二进制文件:

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

    这将创建一个名为的可执行文件 zammad-mcp-go (或 zammad-mcp-go.exe 在Windows上)在当前目录中。

Claude桌面配置

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