¶ osTicket MCP Server
This documentation always describes the latest published version.
¶ Overview
The osTicket MCP Server connects Claude to your osTicket instance. Claude can fetch, search, create, update and delete tickets, upload and download attachments and manage parent-child relationships between tickets, without you switching between your editor and the osTicket interface.
The server runs locally as a Node.js process and talks to the MCP client over stdio. It sends HTTP requests with an API key to osTicket. The endpoints it calls are provided by osTicket plugins.
The server only works together with the osTicket plugin API Endpoints. Creating tickets additionally needs the plugin API Key Wildcard, and the subticket tools need the plugin Subticket Manager.
¶ Documentation
| Page | Content |
|---|---|
| Installation | osTicket-side prerequisites, building the server, configuration file, registering it in the MCP client, update and removal |
| Configuration | All environment variables with defaults, file location, limits |
| Tools | All 12 tools with parameters, return values, required API key permissions and plugin endpoints |
| Usage | Example requests and workflows with attachments, notes and subtickets |
| Security | Handling the API key, TLS, file access, logging, permissions |
| Technical | Architecture, request flow, retries, error handling, file structure |
| Troubleshooting | Error messages, causes and known limitations |
¶ Features
| Feature | Description |
|---|---|
| Read tickets | Single ticket with thread and attachment metadata, list with status filter and pagination, subject search, statistics |
| Create tickets | Markdown, HTML or text, optional project context, defaults for name, email and help topic, up to 5 attachments |
| Change tickets | Status, department, help topic, staff member, SLA, due date, parent ticket, internal note with attachments |
| Delete tickets | Permanently delete a ticket |
| Subtickets | Fetch parent and child tickets, create and remove links |
| Download attachments | Save an attachment of a thread entry to a temporary file |
| Status by name | Status names are resolved to IDs through the osTicket status list |
¶ Requirements
| Requirement | Note |
|---|---|
| Node.js | 18 or higher |
| osTicket with REST API | The plugin documentation names osTicket 1.18.x |
| Plugin API Endpoints | Required for all tools except creating tickets |
| Plugin API Key Wildcard | Required for osticket_create_ticket, because the server uses the endpoint /api/wildcard/tickets.json |
| Plugin Subticket Manager | Only for the four subticket tools |
| API key | With the permissions the tools in use need |
¶ License
The server is released under the MIT license, see LICENSE.
¶ Support
Questions and bugs belong in the issue tracker. Please include the Node.js version, osTicket version, the error message and the lines from the log file.
Developed by Markus Michalski.