Skip to main content
Glama

n8n_add_server

Register or update an n8n server connection by providing its name, URL, and API key. Set an optional default flag to manage workflow operations through AI assistants.

Instructions

Add or update an n8n server connection. The API key can be created in n8n under Settings > API.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
urlYesn8n server URL (e.g. 'http://localhost:5678')
nameYesServer name (e.g. 'production', 'staging')
api_keyYesn8n API key (from Settings > API in n8n)
is_defaultNoOptional default policy: omitted preserves an existing server's flag; true promotes this server; false explicitly removes its default flag.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.1.17
    • removedInput schema / properties / is_default / default
      Removed value: -false
    • changedInput schema / properties / is_default / description
      Previous value: -"Set as default server"New value: +"Optional default policy: omitted preserves an existing server's flag; true promotes this server; false explicitly removes its default flag."
  2. First observedv0.1.6

TDQS

B3.4/5.0
Behavior3/5

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

With no annotations provided, the description carries the transparency burden. It does disclose that the tool mutates state by adding or updating a server connection and mentions an auth prerequisite. However, it does not explain update semantics, idempotency, or what happens to existing server flags or connections.

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?

The description is compact and front-loaded: the core purpose appears in the first sentence, and the supporting API-key note is short. It is slightly redundant with the api_key schema description, but it remains efficient and readable.

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

Completeness3/5

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

The definition is minimally viable for basic invocation: the purpose is clear and required parameters are fully described in the schema. However, it lacks detail on update behavior, expected return/confirmation, and comparison with server-management siblings, and there is no output schema to compensate.

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

Parameters3/5

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

Schema description coverage is 100%, so the schema already documents all four parameters. The description only duplicates the api_key creation note and adds no meaningful semantic value beyond what the input schema already provides.

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

Purpose5/5

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

The description gives a specific verb-resource pair: 'Add or update an n8n server connection.' This clearly distinguishes the tool from siblings like n8n_list_servers, n8n_remove_server, and n8n_ping_server because the action and resource are unambiguous.

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

Usage Guidelines2/5

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

No guidance is given about when to use this tool instead of alternatives such as n8n_list_servers or n8n_remove_server. The description implies its use case through the verb 'add or update,' but never states exclusions, alternatives, or prerequisites beyond API-key creation.

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