Skip to main content
Glama

Health check

ping

Check MCP server health by verifying server version, TypeSafe JS SDK version, pack count, and presence of the TYPESAFE_API_KEY, without revealing the key itself.

Instructions

Health: server version, TypeSafe JS SDK version, pack count, whether TYPESAFE_API_KEY is set. Never echoes the key.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault

No arguments

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.1.0

TDQS

A4.3/5.0
Behavior4/5

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

With no annotations, the description carries the full burden. It discloses what the tool returns and explicitly states the key safety behavior: it never echoes the API key. It could additionally state that it makes no modifications, but a health check is reasonably understood as read-only.

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 compact sentence that lists the relevant details and a safety warning. Every word earns its place, and the most important facts are front-loaded.

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 zero-parameter, read-only health tool with no output schema, this description is fully adequate. It tells the agent what information will be available and the key security constraint, leaving no critical gaps.

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?

There are zero parameters, so the description does not need to explain parameter meaning. The baseline of 4 applies since no parameter information is required.

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 states exactly what the tool reports: server version, SDK version, pack count, and API key presence. It clearly identifies this as a health check, which distinguishes it from the list/describe/run siblings.

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 usage is implied by the name and description: call it to check server health and configuration. However, it does not explicitly say when to use it versus the siblings, nor does it describe common scenarios like verifying connectivity or setup.

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