Skip to main content
Glama

OpenPanel: Health check

openpanel_health_check
Read-only

Check an OpenPanel instance's health and service status for a specified site to diagnose availability problems.

Instructions

[UNIFIED] Check OpenPanel instance health and service status.

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": {
      "site": "<site>"
    },
    "name": "openpanel_health_check"
  }
}

Input Schema

NameRequiredDescriptionDefault
siteYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv3.14.0
  2. Removedv3.13.1
  3. First observedv3.4.0

TDQS

C2.7/5.0
Behavior2/5

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

Annotations already declare readOnlyHint=true, so the safety profile is covered and the description need only add context. It adds almost none: it does not say what is actually checked (connectivity, API credentials, service availability), whether it can fail loudly or return degraded status, or whether auth is required — the sentence largely restates the title.

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?

A single short sentence, front-loaded with the verb and scope — nothing superfluous in the body. The '[UNIFIED]' prefix is meaningless noise that consumes attention without adding information.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

With no output schema and no explanation of return values, the agent cannot know whether the call yields a boolean, a status object, or per-service breakdowns — critical for a health-check tool. Combined with the undocumented required parameter, the definition is too thin for correct invocation.

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

Parameters2/5

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

Schema description coverage is 0% for the single required 'site' parameter, so the description must compensate and it does not. It never explains what 'site' means in the context of an instance health check (instance URL? site identifier?), leaving the one parameter completely opaque.

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?

"Check OpenPanel instance health and service status" gives a specific verb (check) and resource (instance health/service status), which separates it reasonably well from neighbors like openpanel_get_instance_info or openpanel_get_rate_limit_status. It stops short of explicitly naming a sibling or stating what distinguishes a health check from those overlapping tools.

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

Usage Guidelines2/5

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

There is no guidance on when to call this versus alternatives such as openpanel_get_instance_info or the various *health_check siblings, no prerequisites, and no mention of what 'site' must be or when a check is warranted. The agent must infer usage entirely from the name.

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

Deploy Server

Other Tools