Check n8n instance connectivity

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

No annotations exist, so the description carries the full burden. It discloses that the tool checks environment variable presence, reachability, and authentication, but it does not describe the output format (e.g., success/failure status) or error behavior. This is basic transparency without deeper context.

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 a single sentence with no redundant words. It is front-loaded with the main purpose and is appropriately sized for this simple tool.

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?

Given the tool's simplicity (no parameters, no output schema), the description covers the core behavior. However, it could briefly mention what the tool returns or how results are communicated, but this is not critical for a health check tool.

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?

There are zero parameters in the schema, so the baseline is 4. The description adds valuable context by explicitly naming the environment variables (N8N_API_URL/N8N_API_KEY) that the tool checks, which informs the agent about external dependencies beyond the empty schema.

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 uses a specific verb (Verify) and resource (N8N_API_URL/N8N_API_KEY, instance connectivity/authentication), clearly distinguishing it from sibling workflow/credential tools. It is not a tautology and precisely states what the tool does.

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 implies the tool is used to check connectivity/auth before other n8n operations, but it does not explicitly say 'use when...' or mention alternatives. Usage context is inferred from the purpose, but no explicit guidance is provided.

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