Skip to main content
Glama
DavidFuchs

mcp-uptime-kuma

by DavidFuchs

Get Settings

getSettings

Retrieve current Uptime Kuma server settings, including timezone, authentication status, primary base URL, and configuration options. Use it to verify server configuration and troubleshoot setup.

Instructions

Retrieves the current Uptime Kuma server settings including timezone, authentication status, primary base URL, and other configuration options.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
includeSecretsNoReturn credentials in full instead of "***". Off by default: this output is persisted in conversation transcripts and logs. Can also be enabled globally with UPTIME_KUMA_INCLUDE_SECRETS=true.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
settingsYesCurrent Uptime Kuma server settings

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv0.11.15
    • addedOutput schema / properties / settings / properties / domainExpiryNotifyDays
      Added value: +{
      +  "description": "Domain expiry notification days",
      +  "items": {
      +    "type": "number"
      +  },
      +  "type": "array"
      +}
  2. Changed2 schema fields changedv0.11.9
    • changedInput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
    • changedOutput schema / $schema
      Previous value: -"http://json-schema.org/draft-07/schema#"New value: +"https://json-schema.org/draft/2020-12/schema"
  3. First observedv0.0.0-dev

TDQS

A4/5.0
Behavior3/5

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

With no annotations, the description must convey behavioral traits. 'Retrieves' clearly indicates a read-only operation, but it does not disclose the default masking of secrets or the persistence implications of includeSecrets. This information appears in the parameter schema, but the description itself offers minimal behavioral context.

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 a single, well-structured sentence that front-loads the primary action and resource, then adds useful examples of returned settings. There is no wasted or redundant wording.

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?

The tool has an output schema and a single well-documented optional parameter, so the description does not need to explain return values in depth. It is complete for a simple read operation, though a brief note about secret-handling behavior would strengthen it. Overall, an agent has enough to call the tool correctly.

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?

The schema covers 100% of the parameters with a detailed description for includeSecrets, including its default behavior and security implications. The description adds no parameter-level detail, but the baseline of 3 applies because the schema does the heavy lifting.

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 the specific verb 'Retrieves' with the resource 'current Uptime Kuma server settings' and enumerates concrete included fields (timezone, authentication status, primary base URL). It clearly distinguishes this tool from its siblings, none of which target server settings.

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 states the tool fetches current server settings, making it evident when to use it. It does not explicitly mention alternatives, but no sibling tool serves the same purpose, so no exclusions are necessary. The parameter description also provides context about the optional includeSecrets flag.

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