Zammad MCP Go

🚀 Zammad-go-mcp Service

This server is used to access the Zammad API. It offers the following features:

• Read ticket and user lists
• Retrieve detailed information about specific tickets and users
• Search for tickets and users
• Create new tickets
• Add notes (articles) to existing tickets
• Obtain the communication history (articles) of tickets

Feature Modules

This server exposes the following MCP resources and tools:

Resources

Resources allow AI to read data from Zammad in a structured manner via URIs.

• zammad://tickets
  • Name: List tickets
  • Description: List all tickets accessible with the API token.
  • MIME type: application/json
• zammad://tickets/{ticket_id} (template)
  • Name: Display ticket (resource)
  • Description: Show detailed information about a specific ticket identified by its {ticket_id}.
  • MIME type: application/json
• zammad://users
  • Name: List users
  • Description: List all users accessible with the API token.
  • MIME type: application/json
• zammad://users/{user_id} (template)
  • Name: Display user (resource)
  • Description: Show detailed information about a specific user identified by its {user_id}.
  • MIME type: application/json

Tools

Tools allow AI to perform operations or specific queries in Zammad.

• create_ticket: Create a new ticket in Zammad.
  • Required: title, group, customer (email or user ID), body.
  • Optional: tags, priority, status.
• get_ticket: Get detailed information about a specific ticket.
  • Required: ticket_id.
• search_tickets: Search for tickets that meet the criteria.
  • Accepts filtering conditions, such as: tag, priority, status.
• add_comment: Add a note to a ticket.
  • Required: ticket_id, comment.
• search_users: Search for users.
  • Accepts filtering conditions, such as: email, name.

Prerequisites

System Requirements

• Operating System: Windows, Linux, macOS
• Memory: At least 512MB
• Processor: Any modern processor

Install Dependencies

Ensure the following libraries are installed:

• Go: Version 1.20 or higher.
• Git: Used to clone the repository.

Obtain a Zammad API Token

To use this service, you need to obtain a Zammad API token with appropriate permissions. Here are the steps:

1. Log in to the Zammad system.
2. Navigate to the "administer → User" menu.
3. Go to the "API tokens" section.
4. Create a new token and grant the following permissions:
   • view tickets
   • create ticket
   • update ticket
   • delete ticket

Installation and Setup

Clone the Repository

Use Git to clone the project repository:

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

Build the Binary

In the project's root directory, run the following command to build the executable:

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

This will generate an executable named zammad-mcp-go (or zammad-mcp-go.exe on Windows).

Configure Environment Variables

Before running the service, set the following environment variables:

• ZAMMAD_URL: The URL of your Zammad instance, e.g., https://your-zammad-instance.com.
• ZAMMAD_TOKEN: The API token you created.

Configuration Example for Claude Desktop

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