zammad-go-mcp

MCP Server for accessing the Zammad API.

This server enables:

• Reading ticket and user lists.
• Fetching details for specific tickets and users.
• Searching for tickets and users.
• Creating new tickets.
• Adding notes (articles) to existing tickets.
• Retrieving communication history (articles) for tickets.

Capabilities

The server exposes the following MCP Resources and Tools:

Resources allow the AI to read data from Zammad in a structured way using URIs.

• zammad://tickets
  • Name: List Tickets
  • Description: Lists all tickets accessible by the configured API token.
  • MIME Type: application/json
• zammad://tickets/{ticket_id} (Template)
  • Name: Show Ticket (Resource)
  • Description: Shows details for a specific ticket identified by its {ticket_id}.
  • MIME Type: application/json
• zammad://users
  • Name: List Users
  • Description: Lists all users accessible by the configured API token.
  • MIME Type: application/json
• zammad://users/{user_id} (Template)
  • Name: Show User (Resource)
  • Description: Shows details for a specific user identified by their {user_id}.
  • MIME Type: application/json

Tools

Tools allow the AI to perform actions or specific queries within Zammad.

• create_ticket: Creates a new ticket in Zammad.
  • Requires: title, group, customer (email or user ID), body.
  • Optional: type (article type, default: “note”), internal (boolean, default: false).
• search_tickets: Searches for tickets based on a query string.
  • Requires: query.
  • Optional: limit (default: 50).
• add_note_to_ticket: Adds an internal note (article) to an existing ticket.
  • Requires: ticket_id, body.
  • Optional: internal (boolean, default: true).
• get_ticket: Retrieves details for a specific ticket by its ID.
  • Requires: ticket_id.
• get_user: Retrieves details for a specific user by their ID.
  • Requires: user_id.
• search_users: Searches for users based on a query string (e.g., email, login, name).
  • Requires: query.
  • Optional: limit (default: 50).
• get_ticket_articles: Retrieves all articles (communications) for a specific ticket.
  • Requires: ticket_id.

Prerequisites

• Go: Version 1.24 or higher installed.
• Zammad Instance: Access to a running Zammad instance (URL).
• Zammad API Token: An API token generated within your Zammad instance with sufficient permissions.

Getting a Zammad API Token

You need to generate an API token within Zammad to allow this MCP server to authenticate and interact with the API.