Skip to content

healthcheck

Purpose

Check server health and availability

Description

The healthcheck tool returns the current health status of the MCP server, including version information and uptime. It's designed for monitoring and debugging purposes, providing a quick way to verify the server is running and responsive.

This endpoint is commonly used by:

  • Monitoring systems to track server availability
  • Load balancers to determine if the server is healthy
  • Developers to debug connectivity issues
  • CI/CD pipelines to verify deployments

Parameters

None - this tool requires no input parameters.

Example Usage

Ask Claude:

"Check the server health"
"Is the MCP server running?"
"Show me the healthcheck status"
"What version is the server running?"

Response

json
{
  "status": "healthy",
  "version": "1.0.0",
  "uptime": "2h 34m",
  "timestamp": "2025-01-05T10:30:00.000Z"
}

The response includes:

  • status: Server health status (typically "healthy" or "unhealthy")
  • version: Current server version
  • uptime: How long the server has been running
  • timestamp: Current server time

Authentication

Required: No

The healthcheck endpoint is publicly accessible and does not require authentication. This allows monitoring systems and load balancers to check health without needing credentials.

Health Status Values

StatusMeaning
healthyServer is running normally and all systems operational
degradedServer is running but some non-critical systems may be impaired
unhealthyServer has critical issues and may not be fully functional

Common Use Cases

Monitoring

"Check the server health every 5 minutes"

Debugging

"Is the server responding? Run a healthcheck"

Version Verification

"What version of the server is currently deployed?"

Uptime Tracking

"How long has the server been running?"
  • echo - Test basic connectivity
  • system-status - Get detailed system information including memory and load
  • user-info - Check your authentication status

Next Steps

Released under the MIT License.