Skip to main content
Glama
mhajder

Ghostfolio MCP Server

by mhajder

Get Health

get_health
Read-onlyIdempotent

Get system health status.

Instructions

Get system health status.

Retrieves the health status of the Ghostfolio backend service. This is useful to verify if the server is up and running correctly.

Input Schema

NameRequiredDescriptionDefault

No arguments

Output Schema

NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.5.0

TDQS

A3.6/5.0
Behavior3/5

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

Annotations already declare readOnlyHint, idempotentHint and destructiveHint=false, so the safety profile is covered. The description adds only that this is a backend service check; it says nothing about authentication requirements, rate limiting, or what a degraded vs healthy response implies (though the output schema likely covers the payload).

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?

Short and front-loaded, with the purpose in the first line. The second sentence ('Retrieves the health status of the Ghostfolio backend service') largely restates the first, adding only the backend-service detail.

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 a zero-parameter read-only probe with annotations and an output schema, the description gives enough to select and call it. Only edge details such as auth requirements or what failure looks like are absent, which is minor here.

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 takes zero parameters, so there is nothing for the description to disambiguate; the baseline applies. No parameter text is needed and none is missing.

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?

States a specific verb and resource ('get system health status') and names the concrete target (Ghostfolio backend service), so intent is unambiguous. It doesn't need to differentiate from siblings since none of them touch health, but it also makes no explicit contrast.

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

Usage Guidelines3/5

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

'Useful to verify if the server is up and running correctly' gives a clear but generic use case. There are no exclusions, prerequisites, or mentions of when a different diagnostic tool would be preferred.

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