n8n-health-check

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

No annotations are provided, so the description must fully disclose behavior. It mentions returning 'details' but does not specify what they are, nor does it mention any side effects, authentication requirements, rate limits, or timeout behavior beyond the parameter description. The formatting note is a constraint, not behavioral transparency.

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

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

The description is extremely concise, with two sentences plus a highlighted note. The key information is front-loaded, and every part adds value with no wasted words.

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

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

For a simple health check with no output schema, the return structure is only vaguely described. Given sibling diagnostic tools, the description lacks guidance on tool selection. It is adequate but incomplete for an AI agent to confidently choose and use this tool correctly.

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

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

Schema coverage is 100%, so the description adds limited value to parameter meaning. However, the IMPORTANT note about compact JSON formatting is a critical addition not in the schema, ensuring correct invocation. This compensates for the baseline of 3.

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

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

The description clearly states 'Quick health check of n8n instance' and 'Returns healthy/unhealthy status with details', which defines a specific verb-resource combination. It implies a lightweight check, but does not explicitly differentiate from sibling tools like n8n-diagnose, so clarity is high but not perfect.

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

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

The description includes an IMPORTANT note about argument formatting (compact single-line JSON), which is a usage guideline. However, there is no guidance on when to use this tool versus sibling diagnostic tools like n8n-analyze-logs or n8n-diagnose, so context is minimal.

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