n8n MCP Server 使用说明

项目简介

n8n MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在桥接大型语言模型 (LLMs) 和 n8n 工作流自动化平台。通过此服务器，LLMs 可以安全、标准化地与 n8n 实例交互，调用 n8n 的工作流、凭据、执行记录等资源和功能，从而扩展 LLMs 的能力边界，实现更复杂的自动化任务。

主要功能点

工作流管理: 列出、查看、创建、更新、删除、激活和停用 n8n 工作流。
项目管理 (企业版): 列出、创建、更新和删除 n8n 项目 (需要 n8n 企业版许可)。
用户管理: 列出、创建、获取和删除 n8n 用户 (仅限实例所有者)。
变量管理 (企业版): 列出、创建和删除 n8n 变量 (需要 n8n 企业版许可)。
执行管理: 列出、获取和删除 n8n 工作流执行记录。
标签管理: 创建、列出、获取、更新和删除 n8n 标签，以及管理工作流标签。
凭据管理: 创建、删除凭据，并获取凭据 Schema 信息。
安全审计: 生成 n8n 实例的安全审计报告。

安装步骤

推荐方式：使用 npm 安装

确保已安装 Node.js 和 npm。

打开终端，运行以下命令全局安装 n8n MCP Server：

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

从源代码安装

克隆 GitHub 仓库到本地：

git clone https://github.com/illuminaresolutions/n8n-mcp-server.git
cd n8n-mcp-server

安装依赖并构建项目：

npm install
npm run build

启动服务器（后台运行）：

nohup npm start > n8n-mcp.log 2>&1 &

停止服务器：

pkill -f "node build/index.js"

服务器配置

MCP 客户端需要配置 MCP 服务器的启动命令才能连接。以下是针对不同 MCP 客户端的配置示例，您需要根据您的 n8n 实例信息进行配置。

Claude Desktop 配置

修改 Claude Desktop 的配置文件 '~/Library/Application Support/Claude/claude_desktop_config.json'，添加以下 'mcpServers' 配置：

{
  "mcpServers": {
     "n8n": {
      "command": "n8n-mcp-server",
      "env": {
        "N8N_HOST": "https://your-n8n-instance.com",  //  替换为您的 n8n 实例 URL，例如 "https://your-n8n-instance.com"
        "N8N_API_KEY": "your-api-key-here"  // 替换为您的 n8n API 密钥
      }
    }
  }
}

Cline (VS Code 扩展) 配置

打开 VS Code，安装 Cline 扩展，然后在 Cline 扩展面板中点击 "MCP Servers" 图标，点击 "Configure MCP Servers"，在打开的 settings.json 文件中添加以下配置：

{
  "mcpServers": {
    "n8n": {
      "command": "n8n-mcp-server",
      "env": {
        "N8N_HOST": "https://your-n8n-instance.com",  //  替换为您的 n8n 实例 URL，例如 "https://your-n8n-instance.com"
        "N8N_API_KEY": "your-api-key-here"  // 替换为您的 n8n API 密钥
      }
    }
  }
}

Sage (即将支持)

Sage 将通过 Smithery.ai 市场或从 Claude Desktop 导入的方式支持 n8n MCP Server。目前请使用 Claude Desktop 或 Cline 进行配置。

环境变量说明:

'N8N_HOST': 您的 n8n 实例的 URL 地址，确保不包含尾部的斜杠 '/'。例如：'https://your-n8n-instance.com'。
'N8N_API_KEY': 您在 n8n 实例中创建的 API 密钥。请参考安装步骤中的 "Get your n8n API Key" 部分获取 API 密钥。

基本使用方法

启动 MCP 服务器: 按照安装步骤启动 n8n MCP Server。
配置 MCP 客户端: 根据您使用的 LLM 客户端 (如 Claude Desktop, Cline) 的文档，配置 MCP 服务器连接，填入上述 "服务器配置" 部分生成的 JSON 配置信息。
初始化 n8n 连接: 在 LLM 客户端中，使用 'init-n8n' 工具初始化与 n8n 实例的连接。通常您需要提供 n8n 实例的 URL 和 API Key。工具调用时请注意，参数需要以紧凑的单行 JSON 格式提供，去除空格和换行符。例如：
```
{"url":"https://your-n8n-instance.com","apiKey":"YOUR_API_KEY"}
```
成功初始化后，服务器会返回一个客户端 ID，后续操作需要使用此 ID 标识您的 n8n 连接。
使用其他工具: 根据您的需求，使用其他工具与 n8n 交互，例如 'list-workflows' (列出工作流), 'get-workflow' (获取工作流详情), 'execute-workflow' (执行工作流) 等。同样需要注意工具参数的 JSON 格式要求，并提供正确的 'clientId'。
验证连接: 配置完成后，重启 LLM 应用，并尝试向 LLM 提问，例如 "列出我的 n8n 工作流"，验证 n8n MCP Server 是否工作正常。

重要提示:

部分企业版功能 (项目管理、变量管理) 需要 n8n 企业版许可才能使用。
请妥善保管 n8n API 密钥，并遵循安全最佳实践。
详细的工具参数和使用方法请参考代码仓库中的 'src/index.ts' 文件中 'ListToolsRequestSchema' 部分的工具定义。

关键词