Gotify

You can interact with a Gotify instance using the Model Context Protocol (MCP) through a purpose-built server. This MCP server lets you send messages, manage applications and clients, and retrieve health and version information from your Gotify deployment, all via a standardized, fast MCP interface.

How to use

You connect to the Gotify MCP server using an MCP client that supports HTTP transport. The server exposes a ready-to-use HTTP endpoint at your host and port, and you can also run a local process that communicates over the standard MCP protocol. You can perform common Gotify actions such as sending messages, listing and managing applications, and inspecting server health and version details. Use a client to call the available tools by name, passing required tokens and identifiers as described in the tool definitions.

How to install

Prerequisites you need before starting: Python 3.8+ and a running Gotify server instance.

# 1. Clone or download the MCP server files into a directory
#    Place gotify_mcp_server.py, requirements.txt, and .env.example there

# 2. Navigate to the server directory
cd path/to/gotify-mcp

# 3. Create and activate a virtual environment (recommended)
python -m venv .venv
source .venv/bin/activate  # On Windows use: .venv\Scripts\activate

# 4. Install dependencies
pip install -r requirements.txt

# 5. Set up environment variables (copy the example and edit)
cp .env.example .env

# 6. Start the MCP server
python gotify_mcp_server.py

When running, the MCP HTTP service will be available by default at http://0.0.0.0:8000/mcp, and you should see startup logs indicating the server is running.

## Additional sections

Configuration and runtime details below help you tailor the MCP server to your Gotify setup, control how it connects to Gotify, and observe its behavior. Keep your Gotify API URL and admin client token secure, and choose an HTTP transport if you want to expose the MCP endpoints over the network.

## Configuration and runtime details

Environment variables you will interact with include the Gotify API URL and a client token for management operations. You can also configure the MCP transport method, host, port, and log level.

## Troubleshooting

If you encounter issues, verify that the Gotify API URL is reachable and that your admin client token is valid. Check that the MCP server process is running and listening on the expected host and port. Review the console output for authentication errors or connection problems to Gotify.

## Notes

This MCP server uses HTTP (streamable) transport by default and supports standard MCP clients. The server is designed to expose a concise set of tools to manage Gotify resources and monitor health and version state.

## Available tools

### create\_message

Send a new message to a specific Gotify app using the app\_token provided per message.

### get\_messages

Retrieve a list of messages with optional limit and since parameters.

### delete\_message

Delete a specific message by its ID.

### delete\_all\_messages

Delete all messages from Gotify.

### create\_application

Create a new application on the Gotify server.

### get\_applications

Retrieve all applications on the Gotify server.

### update\_application

Update details of a specific application.

### delete\_application

Delete a specific application by its ID.

### create\_client

Create a new client on the Gotify server.

### get\_clients

Retrieve all clients registered on the Gotify server.

### get\_health

Check the health status of the Gotify MCP integration.

### get\_version

Retrieve the Gotify MCP server version.