Houtini-lm

/** * Health Check Plugin - Modern v4.2 Pattern * Checks if LM Studio is running and responding */ import { BasePlugin } from '../plugins/base-plugin.js'; import { IPromptPlugin } from '../prompts/shared/types.js'; import { ResponseFactory } from '../validation/response-factory.js'; import { withSecurity } from '../security/integration-helpers.js'; import { PromptStages } from '../types/prompt-stages.js'; import { LMStudioClient } from '@lmstudio/sdk'; import { config } from '../config.js'; export class HealthCheckPlugin extends BasePlugin implements IPromptPlugin { name = 'health_check'; category = 'system' as const; description = 'Check if LM Studio is running and responding'; parameters = { detailed: { type: 'boolean' as const, description: 'Include detailed information about the loaded model and server status', default: false, required: false } }; async execute(params: any, llmClient: any) { return await withSecurity(this, params, llmClient, async (secureParams) => { try { const client = new LMStudioClient({ baseUrl: config.lmStudioUrl || 'ws://localhost:1234', }); // Try to connect and get basic info const models = await client.llm.listLoaded(); // Get context length from the active model if available let contextLength: number | undefined = undefined; if (models.length > 0) { try { const activeModel = models[0]; // Try to get context length using LM Studio SDK contextLength = await activeModel.getContextLength(); } catch (error) { // If getContextLength fails, try alternative method or leave undefined console.warn('Could not retrieve context length from model:', error); } } // Use ResponseFactory for consistent, spec-compliant output ResponseFactory.setStartTime(); return ResponseFactory.createHealthCheckResponse( 'healthy', 'established', config.lmStudioUrl || 'ws://localhost:1234', undefined, undefined, secureParams.detailed ? { loadedModels: models.map(model => ({ path: model.path, identifier: model.identifier, architecture: (model as any).architecture || 'unknown', contextLength: contextLength // Will be the same for all models since we only check the first one })), modelCount: models.length, hasActiveModel: models.length > 0, contextLength: contextLength, // Add context length to response serverInfo: { url: config.lmStudioUrl, protocol: 'websocket' }, activeModel: models.length > 0 ? { path: models[0].path, identifier: models[0].identifier, architecture: (models[0] as any).architecture || 'unknown', contextLength: contextLength // Add context length to active model } : undefined } : undefined, // Don't provide details in non-detailed mode contextLength // Pass contextLength as separate parameter ); } catch (error: any) { return ResponseFactory.createHealthCheckResponse( 'unhealthy', 'failed', config.lmStudioUrl || 'ws://localhost:1234', error.message || 'Failed to connect to LM Studio', 'Please ensure LM Studio is running and a model is loaded' ); } }); } /** * MODERN v4.2: 3-stage prompt architecture * Note: Health check is a system utility that doesn't use prompts */ getPromptStages(params: any): PromptStages { return { systemAndContext: 'Health check system utility - no prompt required', dataPayload: 'Checking LM Studio connection and model status', outputInstructions: 'Return connection status and model information' }; } /** * LEGACY: Backwards compatibility * DEPRECATED: Will be removed in v5.0 */ getPrompt(params: any): string { // Health check is a utility function, no prompt needed return 'Health check - no prompt required for system utilities'; } } export default HealthCheckPlugin;