Back to N8n Mcp

Claude Desktop Configuration for n8n-MCP

docs/README_CLAUDE_SETUP.md

2.76.06.6 KB
Original Source

Claude Desktop Configuration for n8n-MCP

This guide helps you connect n8n-MCP to Claude Desktop, giving Claude comprehensive knowledge about n8n's 525 workflow automation nodes, including 263 AI-capable tools.

šŸŽÆ Prerequisites

  • Claude Desktop installed
  • For local installation: Node.js (any version)
  • For Docker: Docker installed (see installation instructions in main README)

šŸ› ļø Configuration Methods

  1. Install and build:

    bash
    git clone https://github.com/czlonkowski/n8n-mcp.git
    cd n8n-mcp
    npm install
    npm run build
    npm run rebuild
    
  2. Configure Claude Desktop:

    json
    {
      "mcpServers": {
        "n8n-mcp": {
          "command": "node",
          "args": ["/absolute/path/to/n8n-mcp/dist/mcp/index.js"],
          "env": {
            "NODE_ENV": "production",
            "LOG_LEVEL": "error",
            "MCP_MODE": "stdio",
            "DISABLE_CONSOLE_OUTPUT": "true"
          }
        }
      }
    }
    

āš ļø Important:

  • Use absolute paths, not relative paths
  • The environment variables shown above are critical for proper stdio communication

Method 2: Docker 🐳

No installation needed - runs directly from Docker:

json
{
  "mcpServers": {
    "n8n-mcp": {
      "command": "docker",
      "args": [
        "run", "-i", "--rm",
        "-e", "MCP_MODE=stdio",
        "-e", "LOG_LEVEL=error",
        "-e", "DISABLE_CONSOLE_OUTPUT=true",
        "ghcr.io/czlonkowski/n8n-mcp:latest"
      ]
    }
  }
}

✨ Benefits: No setup required, always up-to-date, isolated environment.

Method 3: Remote Server Connection (Advanced)

āš ļø Note: Remote connections are complex and may have compatibility issues. Consider using local installation instead.

For production deployments with multiple users:

  1. Deploy server with HTTP mode (see HTTP Deployment Guide)

  2. Connect using custom HTTP client:

    json
    {
      "mcpServers": {
        "n8n-remote": {
          "command": "node",
          "args": [
            "/path/to/n8n-mcp/scripts/mcp-http-client.js",
            "http://your-server.com:3000/mcp"
          ],
          "env": {
            "MCP_AUTH_TOKEN": "your-auth-token"
          }
        }
      }
    }
    

šŸ“ Note: Native remote MCP support is available in Claude Pro/Team/Enterprise via Settings > Integrations.

šŸ“ Configuration File Locations

Find your claude_desktop_config.json file:

  • macOS: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%\Claude\claude_desktop_config.json
  • Linux: ~/.config/Claude/claude_desktop_config.json

šŸ”„ Important: After editing, restart Claude Desktop (Cmd/Ctrl+R or quit and reopen).

āœ… Verify Installation

After restarting Claude Desktop:

  1. Look for "n8n-docker" or "n8n-documentation" in the MCP servers list
  2. Try asking Claude: "What n8n nodes are available for working with Slack?"
  3. Or use a tool directly: "Use the search_nodes tool to show me trigger nodes"

šŸ”§ Available Tools

Essential Tool - Start Here!

  • tools_documentation - Get documentation for any MCP tool (ALWAYS use this first!)

Documentation & Validation Tools (offline, always available)

  • search_nodes - Search n8n nodes by keyword, with optional real-world configuration examples
  • get_node - Get node info with progressive detail levels (detail: minimal, standard, full) and modes (schema info, docs, property search, version comparison)
  • validate_node - Validate a node configuration. mode: 'minimal' checks required fields only; mode: 'full' (default) runs full validation against a profile (minimal, runtime, ai-friendly (default), strict)
  • validate_workflow - Full workflow validation: structure, connections, expressions, AI tool connections
  • search_templates - Search workflow templates by keyword, by node type, by task, or by metadata
  • get_template - Get a complete workflow JSON by template ID, ready to import

Management Tools (n8n_*, require n8n API configuration)

See the n8n Management Tools table in the main README for the full list of 21 tools covering workflow CRUD, executions, folders, data tables, credentials, and instance auditing.

Example Questions to Ask Claude:

  • "Show me all n8n nodes for working with databases"
  • "How do I use the HTTP Request node?"
  • "Get the essential properties for the Slack node" (uses get_node with detail='standard')
  • "How can I use Google Sheets as an AI tool?"
  • "Validate my workflow before deployment"
  • "Find templates for webhook automation"

šŸ” Troubleshooting

Server Not Appearing in Claude

  1. Check JSON syntax:

    bash
    # Validate your config file
    cat ~/Library/Application\ Support/Claude/claude_desktop_config.json | jq .
    
  2. Verify paths are absolute (not relative)

  3. Restart Claude Desktop completely (quit and reopen)

Remote Connection Issues

"TransformStream is not defined" error:

  • Cause: Node.js version < 18
  • Fix: Update Node.js to v18 or newer
    bash
    node --version  # Should be v18.0.0 or higher
    

"Server disconnected" error:

  • Check AUTH_TOKEN matches between server and client
  • Verify server is running: curl https://your-server.com/health
  • Check for VPN interference

Docker Issues

"Cannot find image" error:

bash
# Pull the latest image
docker pull ghcr.io/czlonkowski/n8n-mcp:latest

Permission denied:

bash
# Ensure Docker is running
docker ps

Common Issues

"Expected ',' or ']' after array element" errors in logs:

  • Cause: Console output interfering with stdio communication
  • Fix: Ensure all required environment variables are set:
    • MCP_MODE=stdio
    • LOG_LEVEL=error
    • DISABLE_CONSOLE_OUTPUT=true

"NODE_MODULE_VERSION mismatch" warnings:

  • Not a problem! The server automatically falls back to a pure JavaScript implementation
  • The warnings are suppressed with proper environment variables

Server appears but tools don't work:

  • Check that you've built the project: npm run build
  • Verify the database exists: npm run rebuild
  • Restart Claude Desktop completely (quit and reopen)

Quick Fixes

  • šŸ”„ Always restart Claude after config changes
  • šŸ“‹ Copy example configs exactly (watch for typos)
  • šŸ“‚ Use absolute paths (/Users/... not ~/...)
  • šŸ” Check logs: View > Developer > Logs in Claude Desktop
  • šŸ›‘ Set all environment variables shown in the examples

For more help, see Troubleshooting Guide