Skip to main content
Glama

n8n: Health check

n8n_health_check
Read-only

Verify an n8n instance’s health and accessibility to detect availability or access issues before workflows depend on it.

Instructions

[UNIFIED] Check if the n8n instance is healthy and accessible.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "site": "<site>"
    },
    "name": "n8n_health_check"
  }
}

Input Schema

NameRequiredDescriptionDefault
siteYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Addedv3.14.0
  2. Removedv3.13.1
  3. First observedv3.4.0

TDQS

B3.1/5.0
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

The readOnlyHint annotation already establishes this is a safe, non-mutating operation, so the description is not obligated to cover that. What it adds is thin: 'healthy and accessible' is not defined (HTTP reachability? workflow engine status? DB connectivity?), and there is no mention of what a failure looks like or whether it throws versus returns an unhealthy status.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

A single short sentence that leads with the action and resource, with no padding or redundant restatement. The '[UNIFIED]' prefix is low-value noise but does not obscure meaning.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness2/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a tool with one required but entirely undocumented parameter and no output schema, the description should at minimum explain the 'site' argument and the shape of the health result. Neither is present, so an agent would have to guess at invocation details.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters2/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

The single required parameter 'site' has 0% schema description coverage, and the description never mentions it at all. An agent cannot tell whether 'site' is an instance URL, a project identifier, or a bare hostname, nor what format is expected, so the description fails to compensate for the coverage gap.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description names a specific verb (check) and a specific resource (the n8n instance) and scopes it to health/accessibility, which separates it from instance-mutating siblings like n8n_create_workflow. It does not explicitly distinguish itself from other health tools such as check_all_projects_health or get_project_health, so it falls short of a 5.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is only implied: an agent can infer this is the tool for verifying the n8n backend is reachable, but the description never states when to prefer it over project-level or site-level health tools in the sibling list. No exclusion or prerequisite (credentials, target instance) is given.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Deploy Server

Other Tools