Zammad Mcp Server

by Softoft-Orga

356 downloads

Not rated

GitHub

Other
AI

About

A production-ready Model Context Protocol (MCP) server for Zammad, the open-source helpdesk and ticket system. It gives Claude, Cursor, and other MCP clients structured access to tickets, users, organizations, groups, and system metadata with configurable access control.

Details

Author: Softoft-Orga
Downloads: 356
Categories: Other, AI

- Comprehensive API coverage for tickets, users, organizations, groups
- Advanced access control with category‑ and tool‑level permissions
- Supports API tokens, OAuth2, and basic authentication
- Built with FastMCP, Pydantic, and modern Python practices
- Smart caching for static data (groups, states, priorities)
- Type-safe with full runtime validation and 90%+ test coverage

Setting up with Highlight

This MCP is not yet compatible with Highlight’s one-click setup. However, you can still use it with Highlight by following these steps:

Download and install Highlight from highlightai.com/download
Navigate to the plugins tab and select "Add Custom Plugin"
Configure the plugin with the settings below

Plugin Name Zammad Mcp Server

Command (node, npx, python, etc.)

Please refer to the README for specific instructions on how to obtain API keys or other required environment variables.
Enable "Start Automatically" if you want the plugin to start when Highlight launches

Setting up with Cursor

Open Cursor's settings
Navigate to the MCP section
Click "Add new Global MCP server"
Copy and paste the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "zammad mcp server": {
            "zammad": {
                "command": "uvx",
                "args": [
                    "zammad-mcp-server"
                ],
                "env": {
                    "ZAMMAD_URL": "https://your-zammad-instance.example.com",
                    "ZAMMAD_HTTP_TOKEN": "your_api_token",
                    "MCP_DENIED_TOOLS": "delete_ticket,delete_user,delete_organization"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "zammad mcp server": {
            "zammad": {
                "command": "uvx",
                "args": [
                    "zammad-mcp-server"
                ],
                "env": {
                    "ZAMMAD_URL": "https://your-zammad-instance.example.com",
                    "ZAMMAD_HTTP_TOKEN": "your_api_token",
                    "MCP_DENIED_TOOLS": "delete_ticket,delete_user,delete_organization"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "zammad mcp server": {
            "zammad": {
                "command": "uvx",
                "args": [
                    "zammad-mcp-server"
                ],
                "env": {
                    "ZAMMAD_URL": "https://your-zammad-instance.example.com",
                    "ZAMMAD_HTTP_TOKEN": "your_api_token",
                    "MCP_DENIED_TOOLS": "delete_ticket,delete_user,delete_organization"
                }
            }
        }
    }
}

Setting up with Claude Desktop

Open Claude Desktop's settings
Go to the Integrations tab
Click "Add MCP Server"
Use the configuration below based on your operating system

Note: Make sure Claude Desktop is running before attempting to connect.

JSON

{
    "mcpServers": {
        "zammad mcp server": {
            "zammad": {
                "command": "uvx",
                "args": [
                    "zammad-mcp-server"
                ],
                "env": {
                    "ZAMMAD_URL": "https://your-zammad-instance.example.com",
                    "ZAMMAD_HTTP_TOKEN": "your_api_token",
                    "MCP_DENIED_TOOLS": "delete_ticket,delete_user,delete_organization"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "zammad mcp server": {
            "zammad": {
                "command": "uvx",
                "args": [
                    "zammad-mcp-server"
                ],
                "env": {
                    "ZAMMAD_URL": "https://your-zammad-instance.example.com",
                    "ZAMMAD_HTTP_TOKEN": "your_api_token",
                    "MCP_DENIED_TOOLS": "delete_ticket,delete_user,delete_organization"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "zammad mcp server": {
            "zammad": {
                "command": "uvx",
                "args": [
                    "zammad-mcp-server"
                ],
                "env": {
                    "ZAMMAD_URL": "https://your-zammad-instance.example.com",
                    "ZAMMAD_HTTP_TOKEN": "your_api_token",
                    "MCP_DENIED_TOOLS": "delete_ticket,delete_user,delete_organization"
                }
            }
        }
    }
}

Setting up with Windsurf

Open Windsurf's preferences
Go to the Integrations section
Click "Add MCP Integration"
Use the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "zammad mcp server": {
            "zammad": {
                "command": "uvx",
                "args": [
                    "zammad-mcp-server"
                ],
                "env": {
                    "ZAMMAD_URL": "https://your-zammad-instance.example.com",
                    "ZAMMAD_HTTP_TOKEN": "your_api_token",
                    "MCP_DENIED_TOOLS": "delete_ticket,delete_user,delete_organization"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "zammad mcp server": {
            "zammad": {
                "command": "uvx",
                "args": [
                    "zammad-mcp-server"
                ],
                "env": {
                    "ZAMMAD_URL": "https://your-zammad-instance.example.com",
                    "ZAMMAD_HTTP_TOKEN": "your_api_token",
                    "MCP_DENIED_TOOLS": "delete_ticket,delete_user,delete_organization"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "zammad mcp server": {
            "zammad": {
                "command": "uvx",
                "args": [
                    "zammad-mcp-server"
                ],
                "env": {
                    "ZAMMAD_URL": "https://your-zammad-instance.example.com",
                    "ZAMMAD_HTTP_TOKEN": "your_api_token",
                    "MCP_DENIED_TOOLS": "delete_ticket,delete_user,delete_organization"
                }
            }
        }
    }
}

Setting up with Cline

Open Cline's settings
Navigate to the Integrations section
Click "Add MCP Server"
Copy and paste the configuration below based on your operating system

Note: Make sure to restart Cline after adding the configuration.

JSON

{
    "mcpServers": {
        "zammad mcp server": {
            "zammad": {
                "command": "uvx",
                "args": [
                    "zammad-mcp-server"
                ],
                "env": {
                    "ZAMMAD_URL": "https://your-zammad-instance.example.com",
                    "ZAMMAD_HTTP_TOKEN": "your_api_token",
                    "MCP_DENIED_TOOLS": "delete_ticket,delete_user,delete_organization"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "zammad mcp server": {
            "zammad": {
                "command": "uvx",
                "args": [
                    "zammad-mcp-server"
                ],
                "env": {
                    "ZAMMAD_URL": "https://your-zammad-instance.example.com",
                    "ZAMMAD_HTTP_TOKEN": "your_api_token",
                    "MCP_DENIED_TOOLS": "delete_ticket,delete_user,delete_organization"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "zammad mcp server": {
            "zammad": {
                "command": "uvx",
                "args": [
                    "zammad-mcp-server"
                ],
                "env": {
                    "ZAMMAD_URL": "https://your-zammad-instance.example.com",
                    "ZAMMAD_HTTP_TOKEN": "your_api_token",
                    "MCP_DENIED_TOOLS": "delete_ticket,delete_user,delete_organization"
                }
            }
        }
    }
}

Setting up with Goose

Open Goose's preferences
Go to the Integrations tab
Select "MCP Servers"
Click "Add New Server"
Use the configuration below based on your operating system

JSON

{
    "mcpServers": {
        "zammad mcp server": {
            "zammad": {
                "command": "uvx",
                "args": [
                    "zammad-mcp-server"
                ],
                "env": {
                    "ZAMMAD_URL": "https://your-zammad-instance.example.com",
                    "ZAMMAD_HTTP_TOKEN": "your_api_token",
                    "MCP_DENIED_TOOLS": "delete_ticket,delete_user,delete_organization"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "zammad mcp server": {
            "zammad": {
                "command": "uvx",
                "args": [
                    "zammad-mcp-server"
                ],
                "env": {
                    "ZAMMAD_URL": "https://your-zammad-instance.example.com",
                    "ZAMMAD_HTTP_TOKEN": "your_api_token",
                    "MCP_DENIED_TOOLS": "delete_ticket,delete_user,delete_organization"
                }
            }
        }
    }
}

JSON

{
    "mcpServers": {
        "zammad mcp server": {
            "zammad": {
                "command": "uvx",
                "args": [
                    "zammad-mcp-server"
                ],
                "env": {
                    "ZAMMAD_URL": "https://your-zammad-instance.example.com",
                    "ZAMMAD_HTTP_TOKEN": "your_api_token",
                    "MCP_DENIED_TOOLS": "delete_ticket,delete_user,delete_organization"
                }
            }
        }
    }
}

From the repository

Install via pip (pip install zammad-mcp-server) or with uv/uvx. Create a .env file with ZAMMAD_URL and ZAMMAD_HTTP_TOKEN. Run as zammad-mcp-server (stdio transport) or with --transport sse for remote clients. Configure in Claude Desktop / Cursor by adding the command and environment variables to claude_desktop_config.json or the MCP settings.

`health_check`

Check the health of the Zammad MCP Server and its connection to Zammad. Returns: Health status information including server status and connection details.

`get_server_info`

Get information about the Zammad server. Returns: Server version, configuration, and status information.

`get_allowed_tools`

Get a list of all tools accessible to the current session. Returns: List of tools with their categories and permission levels.

`get_ticket`

Get a specific ticket by ID.

`search_tickets`

Search for tickets with various filters.

`create_ticket`

Create a new ticket.

`update_ticket`

Update an existing ticket.

`delete_ticket`

Delete a ticket.

`get_ticket_articles`

Get all articles (messages) for a ticket.

`create_article`

Add a new article to an existing ticket.

`get_ticket_stats`

Get ticket statistics.

`get_ticket_states`

Get all available ticket states. Returns: List of available ticket states with their properties.

`get_priorities`

Get all available ticket priorities. Returns: List of available priority levels.

`get_user`

Get a user by ID.

`search_users`

Search for users.

`create_user`

Create a new user.

`update_user`

Update a user.

`delete_user`

Delete a user.

`get_current_user`

Get the currently authenticated user. Returns: Current user details.

`get_organization`

Get an organization by ID.

`search_organizations`

Search for organizations.

`create_organization`

Create a new organization.

`update_organization`

Update an organization.

`delete_organization`

Delete an organization.

`get_group`

Get a group by ID.

`list_groups`

List all groups. Returns: List of all groups.

Claude Desktop / Cursor

Paste into your MCP client config file to install this server.

{
    "mcpServers": {
        "zammad mcp server": {
            "zammad": {
                "command": "uvx",
                "args": [
                    "zammad-mcp-server"
                ],
                "env": {
                    "ZAMMAD_URL": "https://your-zammad-instance.example.com",
                    "ZAMMAD_HTTP_TOKEN": "your_api_token",
                    "MCP_DENIED_TOOLS": "delete_ticket,delete_user,delete_organization"
                }
            }
        }
    }
}

McpServers

{
    "zammad": {
        "command": "uvx",
        "args": [
            "zammad-mcp-server"
        ],
        "env": {
            "ZAMMAD_URL": "https://your-zammad-instance.example.com",
            "ZAMMAD_HTTP_TOKEN": "your_api_token",
            "MCP_DENIED_TOOLS": "delete_ticket,delete_user,delete_organization"
        }
    }
}

Zammad MCP Server

A powerful, production-ready Model Context Protocol (MCP) server for Zammad - the open-source helpdesk and ticket system.

Overview

The Zammad MCP Server provides AI assistants (like Claude) with structured, type-safe access to Zammad ticket system functionality. Built on the Model Context Protocol, it enables intelligent ticket management, customer support automation, and helpdesk operations through natural language interactions.

Key Features

- Comprehensive API Coverage: Full access to tickets, users, organizations, groups, and more
- Advanced Access Control: Granular permissions with category-based and tool-level restrictions
- Production-Ready: Built with FastMCP, Pydantic, and modern Python practices
- Flexible Authentication: Supports API tokens, OAuth2, and basic authentication
- Smart Caching: Intelligent caching for static data (groups, states, priorities)
- Type-Safe: Full Pydantic models with runtime validation
- Extensible: Easy to add new tools and integrations
- Well-Tested: Comprehensive test suite with 90%+ coverage

Documentation

Full guides, security checklists, and deployment notes live on the Open Ticket AI website:

| Page | What you will learn |
| --- | --- |
| Zammad MCP Server (overview) | Who it is for and how it fits the Zammad + AI landscape |
| Quick Start | Install and run health_check in minutes |
| Claude & Cursor Setup | MCP client configuration |
| Configuration | Environment variables and access policies |
| Tools Reference | All MCP tools by category |
| Security | Tokens, least privilege, production checklist |
| Deployment | Docker, SSE, and production notes |

Tutorial: Zammad MCP Server — setup and usage (blog)

Deutsch: Zammad MCP Server Dokumentation · Einrichtung und Nutzung (Blog)

How this fits the Zammad + AI landscape

- Zammad 7 native AI — built-in summaries and writing assistant inside the Zammad UI.
- Zammad MCP Server (this project) — connects external MCP clients (Claude Desktop, Cursor, custom agents) to Zammad.
- Open Ticket AI Runtime — on-prem inference with custom-trained models via the OTAI Zammad connector (integration guide).

All three can coexist. MCP is the fastest path to “talk to my helpdesk from Claude.” Need custom models on your queues? See Open Ticket AI for Zammad.

Quick Start

> Step-by-step walkthrough: Quick Start guide

Installation

From PyPI (recommended for MCP clients):

```bash
pip install zammad-mcp-server

No reviews yet — be the first

Use Google, GitHub, or an email account so ratings stay tied to real people.

Email sign in

No reviews posted yet.

About

Details

Jump to

Setting up with Highlight

From the repository

health_check

get_server_info

get_allowed_tools

get_ticket

search_tickets

create_ticket

update_ticket

delete_ticket

get_ticket_articles

create_article

get_ticket_stats

get_ticket_states

get_priorities

get_user

search_users

create_user

update_user

delete_user

get_current_user

get_organization

search_organizations

create_organization

update_organization

delete_organization

get_group

list_groups

Claude Desktop / Cursor

McpServers

Zammad MCP Server

Overview

Key Features

Documentation

How this fits the Zammad + AI landscape

Quick Start

Installation

Install

More like this

Sequential Thinking

Filesystem

EverArt

Google Drive

Context 7

Reactive Resume

`health_check`

`get_server_info`

`get_allowed_tools`

`get_ticket`

`search_tickets`

`create_ticket`

`update_ticket`

`delete_ticket`

`get_ticket_articles`

`create_article`

`get_ticket_stats`

`get_ticket_states`

`get_priorities`

`get_user`

`search_users`

`create_user`

`update_user`

`delete_user`

`get_current_user`

`get_organization`

`search_organizations`

`create_organization`

`update_organization`

`delete_organization`

`get_group`

`list_groups`