n8n MCP Service Gateway

This utility establishes a secure, standardized bridge utilizing the Model Context Protocol (MCP) to grant Large Language Models (LLMs) controlled access to n8n automation instances. It manages the invocation of workflows, tracking of job executions, and secure retrieval/storage of necessary authentication tokens.

Deployment Instructions

Obtaining n8n Access Token

1. Authenticate with your designated n8n instance.
2. Locate the user profile controls (typically bottom-left user avatar).
3. Navigate to the 'Settings' panel.
4. Select the 'API Access' section.
5. Generate a new API Key via the provided mechanism.
6. Crucially, copy the generated key immediately, as it will not be displayed again.

Installing the MCP Gateway

Method A: Package Manager Installation (Recommended)

Execute the following command globally:

bash npm install -g @illuminaresolutions/n8n-mcp-server

Method B: Building from Source

1. Clone the source repository: bash git clone https://github.com/illuminaresolutions/n8n-mcp-server.git cd n8n-mcp-server

2. Install prerequisites and compile the application: bash npm install npm run build

3. Initiate the service in a detached process: bash nohup npm start > n8n-mcp.log 2>&1 &

To terminate the running process: bash pkill -f "node build/index.js"

Note: When using Method A, the executable binary is automatically placed within your system's PATH as n8n-mcp-server.

Configuration Setup

Integration with Claude Desktop Environment

1. Access the local configuration file for Claude Desktop:

~/Library/Application Support/Claude/claude_desktop_config.json

1. Append the service definition under the mcpServers map:

{ "mcpServers": { "n8n": { "command": "n8n-mcp-server", "env": { "N8N_HOST": "https://your-n8n-instance.com", "N8N_API_KEY": "your-api-key-here" } } } }

Integration with Cline (VS Code Extension)

1. Ensure the gateway binary is installed (refer to Installation section).
2. Launch VS Code.
3. Open the Cline sidebar extension panel.
4. Click the dedicated 'MCP Servers' glyph located at the top of the panel.
5. Select the option to 'Configure MCP Servers'.
6. Insert the following JSON structure into the opened settings document:

{ "mcpServers": { "n8n": { "command": "n8n-mcp-server", "env": { "N8N_HOST": "https://your-n8n-instance.com", "N8N_API_KEY": "your-api-key-here" } } } }

1. Save the file and confirm the MCP switch is toggled 'ON' (indicated by a green state) and the connectivity indicator is also green.
2. The service is now ready for command invocation via Cline.

Sage Platform

Upcoming availability via: - The Smithery.ai application repository - Direct import mechanism from Claude Desktop configuration

For immediate usage, utilize the Claude Desktop or Cline interfaces.

Verification Protocol

Following configuration:

1. Initiate a restart of your LLM application environment.
2. Prompt the system with a request such as: "List all available n8n automation flows."
3. Successful output should display your registered workflows.

Troubleshooting steps if errors occur: - Confirm the operational status of the n8n backend server. - Double-check the validity and scope of the provided API authentication credential. - Ensure the N8N_HOST URL does not possess a terminating forward slash (/).

Capabilities

Primary Functions

• Inventory retrieval and manipulation of workflows.
• Detailed inspection of specific workflow definitions.
• Triggering remote workflow executions.
• Management of stored configuration secrets/credentials.
• Operations pertaining to execution logs and associated metadata tags.
• Generation of security compliance summaries.
• Tag management across workflows.

Enterprise Tier Functions (n8n Enterprise License Required)

• Advanced organizational project structuring.
• Configuration and utilization of dynamic variables.
• Administration capabilities for system users.

Diagnostic Guidance

Recurring Issues

1. Error: "Client not initialized"
2. Review environment variables: N8N_HOST and N8N_API_KEY.
3. Confirm network reachability to the n8n endpoint.

4. Validate that the API key possesses adequate operational permissions.

5. Error: "License required"

6. Indicates an attempt to invoke proprietary Enterprise functionality.

7. Action required: Either upgrade the n8n subscription or restrict requests to Core features.

8. Connection Malfunctions

9. Verify the n8n server process is actively running.
10. Check the transport layer protocol specified (must be 'http' or 'https').
11. Remove any extraneous trailing slash from the N8N_HOST value.

Security Directives

1. API Key Handling
2. Enforce the principle of least privilege for credentials.
3. Establish a routine schedule for key rotation/renewal.

4. Strictly prohibit embedding keys within source code repositories.

5. Instance Exposure Control

6. Mandate HTTPS usage in all production deployment scenarios.
7. Activate native n8n authentication layers.
8. Maintain the n8n software installation at the latest stable release.

Assistance Channels

• Issue Tracking: GitHub Issues
• Reference Documentation: n8n Documentation

Licensing Information

This software is distributed under the terms of the MIT License.

WIKIPEDIA: The XMLHttpRequest (XHR) interface is a standard JavaScript Application Programming Interface designed to facilitate asynchronous exchange of data between a web client (browser) and a remote server. Its methods enable web applications to dispatch HTTP requests post-page load and process subsequent data responses on the client side. XHR forms the technical foundation for Asynchronous JavaScript and XML (Ajax) techniques. Before Ajax standardized this method, server interaction relied predominantly on full page reloads triggered by traditional hyperlink navigation or form submissions.

== Genesis == The foundational concept for XMLHttpRequest was first conceptualized around the year 2000 by developers associated with the Microsoft Outlook application suite. This idea was subsequently integrated into the Internet Explorer 5 browser release (1999). However, the initial implementation did not use the standardized XMLHttpRequest string literal; developers instead invoked proprietary COM objects named ActiveXObject("Msxml2.XMLHTTP") or ActiveXObject("Microsoft.XMLHTTP"). By the time Internet Explorer 7 surfaced (2006), widespread browser compatibility for the XMLHttpRequest identifier had been achieved across the major rendering engines, including Mozilla's Gecko (2002), Safari 1.2 (2004), and Opera 8.0 (2005).

=== Standardization Track === The World Wide Web Consortium (W3C) formalized the specification for the XMLHttpRequest object, releasing a Working Draft on April 5, 2006. A subsequent Working Draft Level 2 specification, introducing capabilities like event progress monitoring, cross-origin request facilitation, and byte stream handling, was published on February 25, 2008. Towards the conclusion of 2011, the Level 2 extensions were merged back into the primary specification document. In late 2012, the responsibility for maintaining this standard transitioned to the WHATWG, where it continues as a living document defined using Web IDL.

== Operational Methodology == Executing a data request using XMLHttpRequest typically involves a sequence of programmatic actions.

1. Instantiation: Create an instance of the XMLHttpRequest object via its constructor.
2. Configuration: Invoke the "open" method to define the HTTP verb, specify the target resource Uniform Resource Identifier (URI), and declare whether the operation should be synchronous or asynchronous.
3. Listener Setup: For asynchronous operations, attach an event handler to intercept state change notifications.
4. Transmission: Initiate the outbound request by calling the "send" method, potentially carrying a payload.
5. Response Handling: Monitor state transitions within the event listener. Upon completion (state code 4, or "done"), server-transmitted data is typically accessible via the "responseText" property.

Beyond these core steps, XHR provides extensive configuration options. Custom headers can augment the request metadata, and data payloads can be uploaded within the "send" call. Furthermore, the incoming response can be parsed directly into native JavaScript objects (e.g., from JSON), or streamed incrementally rather than waiting for complete data reception. The operation can also be halted prematurely or constrained by a defined timeout period.

== Inter-Domain Communication ==

During the early phases of the World Wide Web's evolution, limitations were discovered regarding the ability to inst