health_check
Check the health status of the GigAPI server to verify its operational state and availability for managing timeseries data.
Instructions
Check the health status of the GigAPI server.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| _ | Yes |
Implementation Reference
- mcp_gigapi/tools.py:179-198 (handler)The main handler function for the 'health_check' MCP tool. It invokes the client's health_check method and formats the response with success status.
def health_check(self) -> Dict[str, Any]: """Check GigAPI server health. Returns: Health status """ try: health = self.client.health_check() return { "health": health, "success": True, "status": "healthy" } except GigAPIClientError as e: logger.error(f"Health check failed: {e}") return { "error": str(e), "success": False, "status": "unhealthy" } - mcp_gigapi/tools.py:253-257 (registration)Registration of the 'health_check' tool using FastMCP's Tool.from_function, binding the GigAPITools.health_check method.
Tool.from_function( lambda _: tools_instance.health_check(), name="health_check", description="Check the health status of the GigAPI server.", ), - mcp_gigapi/client.py:115-123 (helper)Helper method in GigAPIClient that performs the actual HTTP GET request to '/health' endpoint and returns the JSON response.
def health_check(self) -> Dict[str, Any]: """Check GigAPI server health. Returns: Health status response """ response = self._make_request("GET", "/health") return response.json()