API Health Check

Monitors API endpoint health by checking GET localhost:8080/api/ticket, reporting status, response times, and errors.

typescript

0

GitHub Stars

typescript

Language

5 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "eiabhiram-api-healthcheck-mcp": {
      "command": "node",
      "args": [
        "C:/Project Workspace/MCP/build/index.js"
      ],
      "env": {
        "YOUR_TOKEN": "ABC123"
      }
    }
  }
}

The API Health Check MCP Server provides a lightweight way to verify the health and responsiveness of a specific API endpoint, returning a clear status, response time, HTTP status, and any error details with a timestamp. It is designed to help you monitor uptime and performance of your API in real time.

How to use

You use this MCP server by running it as a local process or connecting to it through an MCP client. The server exposes a tool named check_api_health that checks the health of the GET GET localhost:8080/api/ticket endpoint and reports back with a status, response time, HTTP status code, and a timestamp.

To run it locally, start the server using the command and script path provided in your configuration. You will see output that includes whether the API is UP or DOWN, the time it took to respond, the HTTP status if successful, and any error details if the check fails.

How to install

Prerequisites: you need Node.js and npm installed on your machine.

Install dependencies for the project.
Build the project.
Run the compiled server using the specified runtime command.

A common development flow shown in the project uses npm to install, build, and start the server.

Configure the MCP client with the following example to connect to the local server. This configuration snippet shows how to load and run the MCP server in Claude Desktop or a similar client.

{
  "mcpServers": {
    "api-health-check": {
      "command": "node",
      "args": ["C:/Project Workspace/MCP/build/index.js"]
    }
  }
}

Notes and configuration

The server is designed to time out requests after 10 seconds to protect against hanging checks. It reports a detailed error when the API is unreachable or returns non-200 responses, and it formats output with a clear status, timestamp, and performance metrics.

If you need to customize how you run the server, use the standard Node.js runtime with the path to the built entry point as shown in the configuration example above. Ensure your environment has access to the API at localhost:8080.

Development

This server is implemented with the Model Context Protocol SDK, TypeScript, and the Node.js Fetch API. You can develop and test changes by building the TypeScript source and running the resulting JavaScript bundle.

Common development commands include building the project, watching for changes, and starting the compiled server locally.

Available tools

check_api_health

Checks the health of the GET localhost:8080/api/ticket endpoint, returning API status, response time in milliseconds, HTTP status code, error details when applicable, and a timestamp.