topdesk-mcp 0.5.0

MCP server for TOPdesk API using FastMCP and TOPdeskPy SDK

topdesk-mcp

This project is a Model Context Protocol (MCP) server implemented in Python. It exposes the Topdesk API via the TOPdeskPy SDK.

Project Purpose

• Acts as an MCP server to bridge MCP clients with the Topdesk API.
• Uses the TOPdeskPy SDK (with some modifications) for all Topdesk API interactions.

MCP Config JSON

{
  "servers": {
    "topdesk-mcp": {
      "type": "stdio",
      "command": "uvx",
      "args": [
        "--from", 
        "git+https://github.com/dbsanfte/topdesk-mcp@master",
        "topdesk-mcp"
      ],
      "env": {
         "TOPDESK_URL": "<your topdesk URL>",
         "TOPDESK_USERNAME": "<your topdesk username>",
         "TOPDESK_PASSWORD": "<your topdesk api key>"
      }
    }
  }
}

Environment Variables

• TOPDESK_URL: The base URL of your Topdesk instance. e.g. https://yourcompany.topdesk.net
• TOPDESK_USERNAME: The username you generated the API token against.
• TOPDESK_PASSWORD: Your API token
• TOPDESK_MCP_TRANSPORT: (Optional) The transport to use: 'stdio', 'streamable-http', 'sse'. Defaults to 'stdio'.
• TOPDESK_MCP_HOST: (Optional) The host to listen on (for 'streamable-http' and 'sse'). Defaults to '0.0.0.0'.
• TOPDESK_MCP_PORT: (Optional) The port to listen on (for 'streamable-http' and 'sse'). Defaults to '3030'.

Setup for Local Development

1. Ensure Python 3.11+ is installed.

2. Create and activate a virtual environment:

   PowerShell:

   python -m venv .venv
   .venv\Scripts\Activate.ps1
   

   Bash:

   python3 -m venv .venv
   source .venv/bin/activate
   

3. Install dependencies:

   pip install uv
   uv pip install -r requirements.txt
   

4. Run:

   python -m topdesk_mcp.main
   

Notes:

• The server skeleton was generated using the official MCP server template.
• Contributions are welcome.

Package Structure

topdesk_mcp/  # Directory for the MCP server package
    __init__.py     # Marks as a Python package
    main.py         # Entry point for the MCP server
    
    _topdesk_sdk.py # TOPdeskPy SDK
    _incident.py    # Incidents API
    _operator.py    # Operator API
    _person.py      # Person API
    _utils.py       # Helper methods for Requests

References

• MCP Protocol Documentation
• TOPdeskPy SDK
• FastMCP

License

MIT license.