Skip to main content
Glama
mcp-uptime-kuma

mcp-uptime-kuma

List API Keys

listAPIKeys
Read-only

Lists Uptime Kuma API keys with their name, status, and expiry so you can review key health and expiration; key values cannot be retrieved after creation.

Instructions

Returns the API keys for Uptime Kuma's API (such as its Prometheus /metrics endpoint) with name, status (active, inactive or expired) and expiry. The keys themselves cannot be read back: they are shown once, by createAPIKey.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "listAPIKeys"
  }
}

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault
countYes
apiKeysYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv0.17.0

TDQS

A4.7/5.0
Behavior5/5

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

Beyond the readOnlyHint and openWorldHint annotations, the description adds important behavioral context: the result includes name, status values, and expiry, while the actual key material cannot be read back. It also explains that keys are shown once via createAPIKey, which is critical for correctly interpreting the output.

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?

The description is two tightly written sentences, front-loading what the tool returns and then adding the key limitation. Every sentence carries useful information without repetition.

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?

For a no-parameter, read-only listing tool with annotations and an output schema, the description provides enough context to call and interpret it correctly. It covers return fields and the critical constraint that key values are not retrievable after creation.

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?

The tool has zero parameters, so the baseline is 4. The description does not need to compensate for any parameter documentation, and the absence of parameters is consistent with the simple listing operation.

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 uses a specific verb and resource: "Returns the API keys for Uptime Kuma's API." It also distinguishes the operation from createAPIKey by explaining that the key values cannot be read back and are only shown once at creation time.

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?

The description clearly implies this is the tool for listing API key metadata and warns that key values themselves are not retrievable here. It does not give explicit when-not guidance or name other list alternatives, but the intended context is clear for a no-parameter read-only tool.

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