Skip to main content
Glama

explain_service_health

Read-only

Check a service's health status, where it runs, what depends on it, and any detected issues.

Instructions

Get detailed health data for a specific service: current status, where it runs, what depends on it, and any issues detected.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
service_nameYesService name (e.g., 'plex', 'prometheus', 'sonarr')

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Behavior3/5

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

Annotations already declare readOnlyHint=true and openWorldHint=false, so the read-only nature is covered. The description adds context about the data content (status, location, dependencies, issues) but does not disclose any behavioral traits such as response format, pagination, or error handling beyond what the output schema likely covers.

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 ('Get detailed health data') and then specifies what that includes. Every word is informative with no redundancy or verbosity.

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 simple read-only tool with one parameter and an output schema, the description is sufficiently complete. It explains the key purpose and content areas, and the output schema covers return value specifics. No additional prerequisite or edge-case information is necessary for correct invocation.

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 coverage is 100% with the service_name parameter having a clear description and example. The tool description does not add any further parameter semantics beyond restating that it applies to a specific service.

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 clearly states the tool's function: 'Get detailed health data for a specific service' and lists the key components (status, location, dependencies, issues). This differentiates it from siblings like get_service_info (basic info) and show_dependency_chain (only dependencies).

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?

The description implies usage when detailed health data is needed for a specific service, but it does not explicitly state when to use this tool versus alternatives like get_service_info or show_dependency_chain. No exclusion or when-not guidance is provided.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/jo-nike/homelab_mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server