OTRS MCP Server

by spoonbobo

381 downloads
Not rated
GitHub

About

A Model Context Protocol (MCP) server for OTRS (Open Ticket Request System) API integration. It provides standardized MCP interfaces for ticket management, configuration items, and other OTRS functionality, enabling AI assistants to create, search, and manage tickets and…

Details

Author
spoonbobo
Downloads
381
Categories
Other

- Create, read, update, and search tickets
- Access ticket history and detailed information
- Manage configuration items (CMDB)
- Session management and authentication
- Configurable default values for tickets
- Configurable set of available tools

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:

  1. Download and install Highlight from highlightai.com/download
  2. Navigate to the plugins tab and select "Add Custom Plugin"
  3. Configure the plugin with the settings below
    Plugin Name OTRS 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.

  4. Enable "Start Automatically" if you want the plugin to start when Highlight launches

From the repository

Configure using environment variables (OTRS_BASE_URL, OTRS_USERNAME, OTRS_PASSWORD, and optional defaults). Run via Docker (pre-built image or local build) or directly with uv. Add the server configuration to your MCP client (e.g., Claude Desktop) using the provided JSON examples. Requires an OTRS web service with appropriate operations enabled.

Claude Desktop / Cursor

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

{
    "mcpServers": {
        "otrs mcp server": {
            "otrs-mcp-server": {
                "command": "docker",
                "args": [
                    "build",
                    "-t",
                    "otrs-mcp-server",
                    "."
                ]
            }
        }
    }
}

McpServers

{
    "otrs-mcp-server": {
        "command": "docker",
        "args": [
            "build",
            "-t",
            "otrs-mcp-server",
            "."
        ]
    }
}

OTRS MCP Server

A [Model Context Protocol][mcp] (MCP) server for OTRS (Open Ticket Request System) API integration.

This provides access to OTRS ticket management, configuration items, and other OTRS functionality through standardized MCP interfaces, allowing AI assistants to create, search, and manage tickets and configuration items.

[mcp]: https://modelcontextprotocol.io/introduction/introduction

Features

- [x] Create, read, update, and search tickets
- [x] Access ticket history and detailed information
- [x] Manage configuration items (CMDB)
- [x] Session management and authentication
- [x] Configurable default values for tickets
- [x] Docker containerization support
- [x] SSL/TLS support with certificate verification options
- [x] Provide interactive tools for AI assistants

The list of tools is configurable, so you can choose which tools you want to make available to the MCP client.

Prerequisites

OTRS Server Configuration

Before using this MCP server, you need to configure your OTRS instance:

Step 1: Access OTRS Admin Panel

- URL: https://your-otrs-server/otrs/index.pl?Action=Admin
- Login with your admin credentials

Step 2: Configure Web Services

1. Navigate to: System Administration → Web Services
2. Create or verify you have a webservice (e.g., "TestInterface") with these operations:
- ✅ SessionCreate
- ✅ TicketCreate
- ✅ TicketGet
- ✅ TicketSearch
- ✅ TicketUpdate
- ✅ TicketHistoryGet
- ✅ ConfigItemGet
- ✅ ConfigItemSearch

Step 3: Note Your Webservice URL

Your webservice URL should look like:

https://your-otrs-server/otrs/nph-genericinterface.pl/Webservice/YourWebserviceName

Step 4: Ensure User Permissions

Make sure your OTRS user has appropriate permissions for:

- Creating and updating tickets
- Accessing configuration items
- Using the Generic Interface

Usage

Docker (Recommended)

The easiest way to run otrs-mcp with Claude Desktop is using Docker. If you don't have Docker installed, you can get it from Docker's official website.

Using Pre-built Image

You can use the pre-built Docker image from GitHub Container Registry:

{
  "mcpServers": {
    "otrs": {
      "command": "docker",
      "args": [
        "run",
        "--rm",
        "-i",
        "-e",
        "OTRS_BASE_URL=https://your-otrs-server/otrs/nph-genericinterface.pl/Webservice/TestInterface",
        "-e",
        "OTRS_USERNAME=your-username",
        "-e",
        "OTRS_PASSWORD=your-password",
        "-e",
        "OTRS_VERIFY_SSL=false",
        "-e",
        "OTRS_DEFAULT_QUEUE=Raw",
        "-e",
        "OTRS_DEFAULT_STATE=new",
        "-e",
        "OTRS_DEFAULT_PRIORITY=3 normal",
        "ghcr.io/yourusername/otrs-mcp-server:latest"
      ]
    }
  }
}

Building Locally

If you prefer to build the image locally:

```bash

No reviews yet — be the first

Sign in to leave a review

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

Email sign in

No reviews posted yet.