osTicket MCP Server: Installation

osTicket MCP Server installieren: Plugins und API-Key in osTicket vorbereiten, Server klonen und bauen, .env anlegen, im MCP-Client registrieren, aktualisieren und entfernen.

English Version

Zurück zur Übersicht

osTicket MCP Server: Installation

Diese Dokumentation bezieht sich immer auf die aktuellste veröffentlichte Version.

Voraussetzungen

Voraussetzung	Hinweis
Node.js 18 oder höher	`engines` in der `package.json` verlangt `>=18.0.0`
npm	Zum Installieren der Abhängigkeiten und zum Bauen
osTicket mit aktivierter REST-API	Die Plugins unten laufen laut ihrer Dokumentation mit osTicket 1.18.x
Plugin API Endpoints	Liefert die Endpunkte für Lesen, Suchen, Ändern, Löschen, Statistik, Anhang-Download und Subtickets
Plugin API Key Wildcard	Liefert den Endpunkt `/api/wildcard/tickets.json`, den das Tool `osticket_create_ticket` immer anspricht
Plugin Subticket Manager	Nur für die vier Subticket-Tools

Schritt 1: osTicket vorbereiten

Installiere und aktiviere die Plugins aus der Tabelle oben. Die Anleitung steht jeweils auf der Plugin-Seite.
Lege im osTicket-Admin-Panel einen API-Key an. Beim Erstellen von Tickets gelten die normalen osTicket-Regeln für Keys: Der Key muss aktiv sein und zur IP-Adresse passen, von der der MCP-Server anfragt.
Öffne Admin Panel → Verwalten → Plugins → API Endpoints → Configure und aktiviere beim Key die Berechtigungen, die du brauchst. Welches Tool welche Berechtigung verlangt, steht auf der Seite Tools.

Der Wildcard-Endpunkt akzeptiert auch Keys mit der IP 0.0.0.0 von jeder Absender-IP. Das ist laut der Plugin-Dokumentation nur für Entwicklungsumgebungen gedacht. Binde produktive Keys an die feste IP des Rechners, auf dem der MCP-Server läuft.

Schritt 2: Server herunterladen und bauen

Der Server liest seine .env-Datei fest aus ~/.claude/mcp-servers/osticket/.env und schreibt seine Log-Datei nach ~/.claude/mcp-servers/osticket/logs/server.log. Klone das Repository deshalb in dieses Verzeichnis.

git clone https://github.com/markus-michalski/claude-mcp-osTicket.git ~/.claude/mcp-servers/osticket
cd ~/.claude/mcp-servers/osticket
npm install
npm run build

npm run build kompiliert den TypeScript-Quelltext nach dist/. Der Einstiegspunkt ist dist/index.js.

Schritt 3: Konfigurationsdatei anlegen

cp .env.example .env

Trage mindestens OSTICKET_API_URL und OSTICKET_API_KEY ein. Alle Variablen stehen auf der Seite Konfiguration.

OSTICKET_API_URL=https://tickets.example.com
OSTICKET_API_KEY=dein-api-key

Liegt das Verzeichnis woanders, findet der Server die .env nur, wenn sie im Arbeitsverzeichnis des Prozesses liegt. Verlässlicher ist es dann, die Variablen im MCP-Client über env zu übergeben.

Schritt 4: Im MCP-Client registrieren

Der Server ist ein stdio-Server. Der Client startet ihn mit dem Befehl node und dem Pfad zu dist/index.js. In Claude Code geht das zum Beispiel so:

claude mcp add -s user osticket node ~/.claude/mcp-servers/osticket/dist/index.js

Alternativ trägst du den Server in die MCP-Konfiguration deines Clients ein:

{
  "mcpServers": {
    "osticket": {
      "type": "stdio",
      "command": "node",
      "args": ["/home/dein-name/.claude/mcp-servers/osticket/dist/index.js"]
    }
  }
}

Starte den Client danach neu. Beim Start führt der Server eine Zustandsprüfung gegen /api/tickets-stats.php aus. Schlägt sie fehl, schreibt er eine Warnung ins Log und läuft trotzdem weiter.

Update

cd ~/.claude/mcp-servers/osticket
git pull
npm install
npm run build

Starte den MCP-Client danach neu, damit der neue Build geladen wird.

Entfernen

Entferne den Eintrag osticket aus der MCP-Konfiguration, in Claude Code mit claude mcp remove osticket.
Lösche das Verzeichnis ~/.claude/mcp-servers/osticket. Darin liegen auch .env und die Log-Dateien.
Deaktiviere oder lösche in osTicket den API-Key, den der Server genutzt hat.