Skip to main content
Glama
mcp-uptime-kuma

mcp-uptime-kuma

Create API Key

createAPIKey

Create a named API key for Uptime Kuma to authenticate Prometheus /metrics scraping via HTTP basic auth. Returns the key once for the user to store before it expires.

Instructions

Creates an API key and returns it. It is sent as the password of HTTP basic auth, with any username. This is the only time the key can be read, and it stays in this conversation's transcript, so give it to the user to store and do not repeat it. Note: once any key exists, Uptime Kuma's /metrics endpoint takes API keys instead of the admin username and password, so a Prometheus scraper still using those must switch.

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": {
      "name": "<name>"
    },
    "name": "createAPIKey"
  }
}

Input Schema

NameRequiredDescriptionDefault
nameYesWhat the key is for, e.g. "prometheus"
expiresNoWhen it stops working, in the server's local time: "YYYY-MM-DD" (end of that day) or "YYYY-MM-DD HH:mm". Omit for never.

Output Schema

NameRequiredDescriptionDefault
okYes
keyNoThe key itself, e.g. "uk1_…". Shown only now.
keyIDNo
expiresYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.17.0

TDQS

A4.4/5.0
Behavior5/5

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

Goes well beyond the annotations (readOnlyHint=false, destructiveHint=false, idempotentHint=false): it discloses that the key is readable exactly once and remains in the conversation transcript, imposes a handling instruction, and documents a real side effect — the /metrics endpoint changing its authentication scheme once a key exists. That is exactly the non-obvious behavioral context an agent needs before committing.

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 sentences, front-loaded with the action and result, then the operational handling rule, then the metrics caveat. Dense but every clause is load-bearing; the metrics note is long but prevents a real breakage, so it earns its place.

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

Completeness5/5

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

An output schema exists, so return-value shape need not be explained, and the description instead covers the things structured data cannot: one-time readability, credential handling, and the authentication change triggered on the /metrics endpoint. Complete for a two-parameter creation tool with annotations already declaring its safety profile.

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%, with the name and expires parameters documented including the local-time formats and the "end of that day" semantics. The description adds no parameter-level meaning beyond that, so it sits at the baseline where the schema carries the burden.

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

Purpose5/5

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

States a specific verb and resource ("Creates an API key and returns it") and immediately clarifies what the returned value is used for (HTTP basic auth password with any username). This distinguishes it cleanly from sibling admin tools such as deleteAPIKey and setAPIKeyActive, which do not produce a credential.

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?

Gives clear operative guidance: hand the key to the user, do not repeat it, and warns that once any key exists the /metrics endpoint stops accepting admin username/password so a Prometheus scraper must be switched. It does not explicitly name an alternative tool or state when not to create a key, but for a single-shot creation tool the surrounding context is sufficient.

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