get_health
Perform a health check for the Trading Simulator API to ensure availability and operational status, supporting AI-driven trading interactions.
Instructions
Basic health check for the trading simulator API
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Input Schema (JSON Schema)
{
"$schema": "http://json-schema.org/draft-07/schema#",
"additionalProperties": false,
"properties": {},
"type": "object"
}
Implementation Reference
- src/index.ts:633-639 (handler)The MCP tool handler for 'get_health', which invokes 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 (schema)The input schema definition for the 'get_health' tool, which requires no parameters.{ 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:411-414 (registration)Registration of all tools including 'get_health' via the ListToolsRequestSchema handler, which returns the TRADING_SIM_TOOLS array containing the tool definition.server.setRequestHandler(ListToolsRequestSchema, async () => { return { tools: TRADING_SIM_TOOLS };