n8n_health_check
Check the health status of your n8n instance to ensure it's running properly and identify any issues affecting workflow execution.
Instructions
Check the health status of the n8n instance
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/index.ts:412-424 (handler)The handler for the n8n_health_check tool which calls the n8nClient and formats the response.
case 'n8n_health_check': { const isHealthy = await n8nClient.healthCheck(); return { content: [{ type: 'text', text: formatResponse({ status: isHealthy ? 'healthy' : 'unhealthy', url: BASE_URL, timestamp: new Date().toISOString(), }), }], }; } - src/index.ts:922-929 (registration)The tool registration for n8n_health_check.
{ name: 'n8n_health_check', description: 'Check the health status of the n8n instance', inputSchema: { type: 'object', properties: {}, }, }, - src/n8n-client.ts:288-295 (helper)The implementation of the health check API call within the N8nClient class.
async healthCheck(): Promise<boolean> { try { await this.client.get('/workflows?limit=1'); return true; } catch { return false; } }