Skip to main content
Glama
mcp-uptime-kuma

mcp-uptime-kuma

Set API Key Active

setAPIKeyActive
Idempotent

Toggles an API key on or off to allow or refuse requests using it; expired keys remain expired, and permanent removal requires deletion.

Instructions

Switches an API key off (active: false), so requests using it are refused, or back on (active: true). An expired key stays expired. To remove it for good use deleteAPIKey. Find the ID with listAPIKeys.

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": {
      "keyID": "<keyID>",
      "active": "<active>"
    },
    "name": "setAPIKeyActive"
  }
}

Input Schema

NameRequiredDescriptionDefault
keyIDYesThe ID of the API key
activeYesfalse switches the key off, true back on

Output Schema

NameRequiredDescriptionDefault
okYes
keyIDYes
activeYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.17.0

TDQS

A4.7/5.0
Behavior4/5

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

Annotations already declare this is a non-read-only, idempotent, non-destructive mutation, and the description reinforces that framing by explaining the consequence (requests using the key are refused) and that the change is reversible rather than a delete. It stops short of noting permission requirements or any propagation delay, which keeps it from a 5.

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

Conciseness5/5

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

Three short sentences with the state change front-loaded, followed by the caveat and then the sibling pointers. No sentence is redundant and nothing important is buried.

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 values need not be explained, and annotations cover the safety profile. The description supplies the remaining decision-relevant facts: effect of the toggle, expiration behavior, and alternatives.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3, but the description adds outcome semantics the schema does not: 'active: false' means requests are refused, and reactivation does not revive an expired key. That is real meaning beyond the field descriptions.

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?

The description names a specific verb and resource ('Switches an API key off... or back on') and immediately disambiguates it from the two obvious siblings, deleteAPIKey and listAPIKeys. An agent can tell exactly what state change this tool performs without opening the schema.

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

Usage Guidelines5/5

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

It explicitly routes the agent: use deleteAPIKey for permanent removal, listAPIKeys to obtain the keyID. It also states a real usage caveat — an expired key stays expired even when reactivated — which prevents a plausible misuse.

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