Skip to main content
Glama
mcp-uptime-kuma

mcp-uptime-kuma

Create Proxy

createProxy

Add an HTTP or SOCKS proxy for Uptime Kuma monitors, assign it via proxyId on create/update, or route all existing monitors through it with applyExisting. Supports optional credentials.

Instructions

Adds an HTTP or SOCKS proxy. Monitors use it once their proxyId is set to its ID (createMonitor / updateMonitor), or all at once with applyExisting. Pass username and password for a proxy that needs them.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "protocol": "<protocol>",
      "host": "<host>",
      "port": "<port>"
    },
    "name": "createProxy"
  }
}

Input Schema

NameRequiredDescriptionDefault
hostYesProxy host name or IP address
portYesProxy port
defaultNoMake it the proxy the web UI preselects for new monitors; the previous default stops being one
passwordNoFor a proxy that needs a login. A credential.
protocolYesProxy protocol: http, https, socks, socks5, socks5h, socks4
usernameNoFor a proxy that needs a login
applyExistingNoAlso route every existing monitor through this proxy now. One-off: it is not stored.
includeSecretsNoReturn credentials in full instead of "***"; they then stay in the transcript. Default: false, or UPTIME_KUMA_INCLUDE_SECRETS.

Output Schema

NameRequiredDescriptionDefault
okYes
proxyNo
proxyIDNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.17.0

TDQS

A3.9/5.0
Behavior4/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Annotations already establish this is a non-idempotent, non-destructive write, so the description's job is to add context, and it does: proxy-to-monitor binding via proxyId and the bulk applyExisting path. Credential handling is flagged ("Pass username and password for a proxy that needs them"), though the secret-exposure behavior lives in the schema rather than the description.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Three short sentences, front-loaded with the action, then the linkage mechanism, then the credential note. No filler; the parenthetical sibling references are compact and useful.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness4/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For an 8-parameter creation tool with full schema coverage, annotations, and an output schema, the description supplies the missing operational context: how monitors start using the proxy and what applyExisting does at a high level. Only the default-flag behavior and the secret-return tradeoff are left entirely to the schema, which is acceptable given their inline documentation.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so all eight parameters including default, applyExisting, includeSecrets, and protocol are already documented inline. The description only adds usage meaning for username/password and applyExisting, which is a modest increment over the schema baseline.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

Opens with a specific verb and resource ("Adds an HTTP or SOCKS proxy") and names the related siblings createMonitor/updateMonitor so the agent sees where this fits. The "HTTP or SOCKS" phrasing slightly under-describes the protocol enum (https, socks4, socks5h), but the core purpose is unmistakable and distinct from updateProxy/deleteProxy.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines4/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explains the actual usage pattern rather than just the action: monitors adopt the proxy once their proxyId is set, or all at once via applyExisting, and credentials are passed for proxies that need login. It does not explicitly say when to prefer updateProxy over creating a new proxy, which is the remaining gap.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.