get_health
Check the operational status of the Trading Simulator API to verify connectivity and service availability.
Instructions
Basic health check for the trading simulator API
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/index.ts:633-639 (handler)MCP tool handler for 'get_health': calls tradingClient.getHealthStatus() and formats the response as MCP content.case "get_health": { const response = await tradingClient.getHealthStatus(); return { content: [{ type: "text", text: JSON.stringify(response, null, 2) }], isError: false }; }
- src/index.ts:388-397 (registration)Tool registration in TRADING_SIM_TOOLS array returned by ListToolsRequestSchema handler.{ name: "get_health", description: "Basic health check for the trading simulator API", inputSchema: { type: "object", properties: {}, additionalProperties: false, $schema: "http://json-schema.org/draft-07/schema#" } },
- src/index.ts:391-395 (schema)Input schema definition for the get_health tool (empty object, no parameters required).inputSchema: { type: "object", properties: {}, additionalProperties: false, $schema: "http://json-schema.org/draft-07/schema#"
- src/api-client.ts:582-589 (helper)Helper method in TradingSimulatorClient that makes the actual API call to /api/health for health status.async getHealthStatus(): Promise<HealthCheckResponse | ErrorResponse> { return this.request<HealthCheckResponse>( 'GET', '/api/health', null, 'get health status' ); }