n8n MCP Server

一个模型上下文协议（MCP）服务器，允许 AI 助手通过自然语言与 n8n 工作流进行交互。

概述

本项目提供了一个模型上下文协议（MCP）服务器，使 AI 助手能够无缝地与 n8n（一款流行的自动化工作流工具）进行交互。它充当桥梁，让 AI 助手能够使用自然语言命令以编程方式管理和控制 n8n 工作流及其执行。

安装

前提条件

• Node.js 20 或更高版本
• 已启用 API 访问的 n8n 实例

通过 npm 安装

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

从源码安装

# 克隆仓库
git clone https://github.com/leonardsellem/n8n-mcp-server.git
cd n8n-mcp-server

# 安装依赖
npm install

# 构建项目
npm run build

# 可选：全局安装
npm install -g .

Docker 安装

你也可以使用 Docker 运行该服务器：

# 拉取镜像
docker pull leonardsellem/n8n-mcp-server

# 使用你的 n8n API 配置运行容器
docker run -e N8N_API_URL=http://your-n8n:5678/api/v1 \
  -e N8N_API_KEY=your_n8n_api_key \
  -e N8N_WEBHOOK_USERNAME=username \
  -e N8N_WEBHOOK_PASSWORD=password \
  leonardsellem/n8n-mcp-server

更新服务器

更新方式取决于你最初的安装方式。

1. 通过 npm 全局安装

如果你使用 npm install -g @leonardsellem/n8n-mcp-server 安装了服务器：

1. 打开终端或命令提示符。
2. 运行以下命令获取最新版本：

   npm install -g @leonardsellem/n8n-mcp-server@latest
   

3. 如果服务器当前正在运行（例如作为后台进程或服务），你需要重启它才能使更改生效。

2. 从源码安装

如果你克隆了仓库并从源码安装：

1. 打开终端或命令提示符。
2. 导航到你克隆项目的目录：

   cd path/to/n8n-mcp-server
   

3. 如果你对代码做了任何想要保留的本地更改，可以考虑暂存它们（可选）：

   git stash
   

   之后你可以使用 git stash pop 恢复它们。
4. 从仓库拉取最新更改（假设你在 main 分支上）：

   git pull origin main
   

   如果你在其他分支，请将 main 替换为你的分支名称。
5. 安装或更新任何更改的依赖：

   npm install
   

6. 重新构建项目以包含最新更新：

   npm run build
   

7. 如果你之前使用 npm install -g . 从该源码目录全局安装过，你可能需要再次运行此命令以更新全局链接：

   npm install -g .
   

8. 重启服务器。
   • 如果你在 AI 助手的 MCP 配置中直接使用类似 node build/index.js 的命令运行服务器，请确保路径仍然正确。使用 npm install -g . 然后将 n8n-mcp-server 作为命令应该能保持一致性。

3. 使用 Docker

如果你使用 Docker 运行服务器：

1. 从 Docker Hub 拉取最新镜像：

   docker pull leonardsellem/n8n-mcp-server:latest
   

2. 停止并移除旧容器。你需要容器的名称或 ID（可以使用 docker ps 查找）：

   docker stop <your_container_name_or_id>
   docker rm <your_container_name_or_id>
   

3. 使用更新后的镜像启动新容器。使用你之前使用的相同 docker run 命令，包括所有必要的环境变量（示例命令请参考“Docker 安装”部分）。例如：

   docker run -e N8N_API_URL=http://your-n8n:5678/api/v1 \
     -e N8N_API_KEY=your_n8n_api_key \
     -e N8N_WEBHOOK_USERNAME=username \
     -e N8N_WEBHOOK_PASSWORD=password \
     leonardsellem/n8n-mcp-server:latest
   

   确保使用 :latest 或你打算运行的特定版本标签。

配置

在运行服务器的目录中，使用 .env.example 作为模板创建 .env 文件：

cp .env.example .env

配置以下环境变量：

| 变量 | 描述 | 示例 | |----------|-------------|---------| | N8N_API_URL | n8n API 的完整 URL，包含 /api/v1 | http://localhost:5678/api/v1 | | N8N_API_KEY | 用于与 n8n 进行身份验证的 API 密钥 | n8n_api_... | | N8N_WEBHOOK_USERNAME | Webhook 身份验证的用户名（如果使用 webhook） | username | | N8N_WEBHOOK_PASSWORD | Webhook 身份验证的密码 | password | | DEBUG | 启用调试日志（可选） | true 或 false |

生成 n8n API 密钥

1. 在浏览器中打开你的 n8n 实例
2. 前往设置 > AP…