The server marks this tool destructive: it may delete or overwrite data

zammad_add_internal_note

WRITE: add an INTERNAL note (visible to agents only, never e-mailed to the customer) to ONE ticket. Needs an agent's token (a customer's token is refused, because Zammad would make the note public). The ticket's other data is not changed. POST /api/v1/ticket_articles with type=note, internal=true.

destructive

Argument	Type	Description
body*	string	Note text (plain text).
subject	string	Optional note subject (one line).
ticket_id*	integer	Zammad ticket id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "ticket_id",
    "body"
  ],
  "properties": {
    "body": {
      "type": "string",
      "maxLength": 100000,
      "minLength": 1,
      "description": "Note text (plain text)."
    },
    "subject": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Optional note subject (one line)."
    },
    "ticket_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Zammad ticket id.",
      "exclusiveMinimum": 0
    }
  }
}

zammad_create_ticket

WRITE: create ONE new ticket for an EXISTING customer (by e-mail address or user id) in a group, with a first article recorded as written by the customer (type note or phone). It does not send an e-mail by itself, but the instance's triggers may (for example an automatic confirmation to the customer). It never creates new users. POST /api/v1/tickets.

destructive

Argument	Type	Description
body*	string	First message of the ticket (plain text).
group*	string	Group name the ticket goes to, e.g. Users or Sales.
state	string	Initial state name (default: new).
title*	string	Ticket title.
subject	string	Subject of the first article (default: the title).
customer	string	E-mail address of an existing customer. Give this or customer_id.
owner_id	integer	User id of the agent who should own the ticket.
priority	string	Initial priority name (default: 2 normal).

zammad_get_me

The Zammad user this access token belongs to: id, name, e-mail, roles and groups. Use it to confirm the connection and the token's permissions. GET /api/v1/users/me.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

zammad_get_organization

One organization by id: name, domain, notes, VIP flag, member ids. GET /api/v1/organizations/{id}.

read-only

Argument	Type	Description
organization_id*	integer	Zammad organization id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "organization_id"
  ],
  "properties": {
    "organization_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Zammad organization id.",
      "exclusiveMinimum": 0
    }
  }
}

zammad_get_ticket

One ticket by its numeric id (not the ticket number): title, group, state, priority, owner, customer, organization, dates, escalation and article count. GET /api/v1/tickets/{id}?expand=true.

read-only

Argument	Type	Description
ticket_id*	integer	Zammad ticket id (the number in the ticket URL, not the 5-digit ticket number).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "ticket_id"
  ],
  "properties": {
    "ticket_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Zammad ticket id (the number in the ticket URL, not the 5-digit ticket number).",
      "exclusiveMinimum": 0
    }
  }
}

zammad_get_ticket_article

One article by its id with its full body, headers and attachment names. GET /api/v1/ticket_articles/{id}.

read-only

Argument	Type	Description
article_id*	integer	Zammad article id (from zammad_list_ticket_articles).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "article_id"
  ],
  "properties": {
    "article_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Zammad article id (from zammad_list_ticket_articles).",
      "exclusiveMinimum": 0
    }
  }
}

zammad_get_user

One user (customer or agent) by id: name, e-mail, phone, organization, roles, VIP flag and notes. No credentials. GET /api/v1/users/{id}?expand=true.

read-only

Argument	Type	Description
user_id*	integer	Zammad user id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "user_id"
  ],
  "properties": {
    "user_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Zammad user id.",
      "exclusiveMinimum": 0
    }
  }
}

zammad_list_groups

The ticket groups (queues) of the instance, with ids, names and agent ids. Zammad requires the admin.group permission for this list; with an agent-only token it returns an authorization error. GET /api/v1/groups.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
per_page	integer	Results per page, 1-100 (default 25).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "per_page": {
      "type": "integer",
      "maximum": 100,
      "description": "Results per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    }
  }
}

zammad_list_organizations

List customer organizations with domain, VIP flag and member ids. Needs an agent token. GET /api/v1/organizations.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
per_page	integer	Results per page, 1-100 (default 25).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "per_page": {
      "type": "integer",
      "maximum": 100,
      "description": "Results per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    }
  }
}

zammad_list_ticket_articles

All articles (messages, internal notes, e-mails, phone notes) of one ticket in order, with sender, type, internal flag, from/to/cc, subject, body and attachment names (attachments are not downloaded). Long bodies are cut at 6000 characters; use zammad_get_ticket_article for the full text. GET /api/v1/ticket_articles/by_ticket/{ticket_id}.

read-only

Argument	Type	Description
ticket_id*	integer	Zammad ticket id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "ticket_id"
  ],
  "properties": {
    "ticket_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Zammad ticket id.",
      "exclusiveMinimum": 0
    }
  }
}

zammad_list_ticket_priorities

The ticket priorities of the instance (e.g. '1 low', '2 normal', '3 high') with ids. Use the names in zammad_update_ticket. GET /api/v1/ticket_priorities.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

zammad_list_ticket_states

The ticket states of the instance (new, open, pending reminder, pending close, closed, ...) with ids and whether they are active. Use the names in zammad_update_ticket. GET /api/v1/ticket_states.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

zammad_list_ticket_tags

The tags on one ticket. GET /api/v1/tags?object=Ticket&o_id={ticket_id}. Needs an agent token.

read-only

Argument	Type	Description
ticket_id*	integer	Zammad ticket id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "ticket_id"
  ],
  "properties": {
    "ticket_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Zammad ticket id.",
      "exclusiveMinimum": 0
    }
  }
}

zammad_list_tickets

List the tickets the token's user can see (an agent sees the tickets of their groups; a customer only their own). For anything targeted use zammad_search_tickets. GET /api/v1/tickets?expand=true.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
per_page	integer	Results per page, 1-100 (default 25).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "per_page": {
      "type": "integer",
      "maximum": 100,
      "description": "Results per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    }
  }
}

zammad_reply_to_ticket

WRITE: send a customer-visible reply on ONE ticket. THIS E-MAILS A REAL PERSON: the reply is delivered by e-mail to exactly ONE recipient and cannot be recalled. By default the recipient is the ticket's customer (looked up from the ticket); `to` may name one other single address. No cc, no bulk, no attachments. Needs an agent's token (a customer's token is refused). For an internal remark use zammad_add_internal_note. GET /api/v1/tickets/{id}, then POST /api/v1/ticket_articles with type=email, internal=false.

destructive

Argument	Type	Description
to	string	Optional: ONE recipient e-mail address. Default: the ticket customer's address.
body*	string	Reply text (plain text).
subject	string	Optional subject (one line). Default: 'Re: <ticket title>'.
ticket_id*	integer	Zammad ticket id.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "ticket_id",
    "body"
  ],
  "properties": {
    "to": {
      "type": "string",
      "pattern": "^[^\\s,;<>\"'()[\\]\\\\@]+@[^\\s,;<>\"'()[\\]\\\\@]+\\.[^\\s,;<>\"'()[\\]\\\\@]+$",
      "maxLength": 254,
      "description": "Optional: ONE recipient e-mail address. Default: the ticket customer's address."
    },
    "body": {
      "type": "string",
      "maxLength": 100000,
      "minLength": 1,
      "description": "Reply text (plain text)."
    },
    "subject": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "Optional subject (one line). Default: 'Re: <ticket title>'."
    },
    "ticket_id": {
      "type": "integer",
      "maximum": 9007199254740991,
      "description": "Zammad ticket id.",
      "exclusiveMinimum": 0
    }
  }
}

zammad_search_organizations

Search customer organizations by name or domain. Needs an agent token. GET /api/v1/organizations/search.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
query*	string	Search text, e.g. an organization name.
per_page	integer	Results per page, 1-100 (default 25).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "query"
  ],
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "query": {
      "type": "string",
      "maxLength": 300,
      "minLength": 1,
      "description": "Search text, e.g. an organization name."
    },
    "per_page": {
      "type": "integer",
      "maximum": 100,
      "description": "Results per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    }
  }
}

zammad_search_tickets

Search tickets with Zammad's query syntax. With Elasticsearch on the instance you can use fields, e.g. `state.name:open AND group.name:Sales`, `customer.email:"[email protected]"`, `title:invoice`, `number:20001`; a plain word searches ticket text. Replies carry ids plus names (group, state, priority, owner, customer). GET /api/v1/tickets/search?expand=true.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
query*	string	Search query.
sort_by	string	Field to sort by, e.g. updated_at or created_at.
order_by	string	Sort direction (default: relevance).
per_page	integer	Results per page, 1-100 (default 25).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "query"
  ],
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "query": {
      "type": "string",
      "maxLength": 500,
      "minLength": 1,
      "description": "Search query."
    },
    "sort_by": {
      "type": "string",
      "pattern": "^[a-z_.]{1,60}$",
      "description": "Field to sort by, e.g. updated_at or created_at."
    },
    "order_by": {
      "enum": [
        "asc",
        "desc"
      ],
      "type": "string",
      "description": "Sort direction (default: relevance)."
    },
    "per_page": {
      "type": "integer",
      "maximum": 100,
      "description": "Results per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    }
  }
}

zammad_search_users

Search customers and agents by name, e-mail, login, phone or organization. Returns profile fields (no credentials). Needs an agent token. GET /api/v1/users/search?expand=true.

read-only

Argument	Type	Description
page	integer	Page number, from 1 (default 1). Pass the previous reply's next_page.
query*	string	Search text, e.g. an e-mail address or a name.
per_page	integer	Results per page, 1-100 (default 25).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "query"
  ],
  "properties": {
    "page": {
      "type": "integer",
      "maximum": 100000,
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "exclusiveMinimum": 0
    },
    "query": {
      "type": "string",
      "maxLength": 300,
      "minLength": 1,
      "description": "Search text, e.g. an e-mail address or a name."
    },
    "per_page": {
      "type": "integer",
      "maximum": 100,
      "description": "Results per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    }
  }
}

zammad_update_ticket

WRITE: change fields of ONE ticket: state, priority, owner (agent), group and/or title. Use names from zammad_list_ticket_states / zammad_list_ticket_priorities / zammad_list_groups. Pending states need `pending_time`. Never deletes, removes or merges (those states are refused). The instance's own triggers still run, so closing or reassigning a ticket can send the customer or agent a notification e-mail. PUT /api/v1/tickets/{id}.

destructive

Argument	Type	Description
group	string	Group name, e.g. Sales (subgroups as Sales::Europe).
state	string	State name, e.g. open, closed, 'pending reminder'.
title	string	New ticket title.
owner_id	integer	User id of the agent who should own the ticket. Id 1 is Zammad's 'no owner' placeholder.
priority	string	Priority name, e.g. '3 high'.
ticket_id*	integer	Zammad ticket id.
pending_time	string	Required for the pending states: when the ticket reminds or closes, ISO 8601 with a timezone.

Input schema (JSON)

Zammad MCP by usefulapi

Try it

zammad_add_internal_note Destructive

Zammad MCP by usefulapi

Try it

zammad_add_internal_note Destructive

Tools (19)