
N8n Workflow Builder
MCP服务器,用于以编程方式创建和管理n8n工作流
概述
n8n Workflow Builder MCP 服务器
该项目为管理n8n工作流提供了MCP服务器支持,通过预定义工具集实现工作流的列出、创建、更新、删除、激活与停用功能。
重要说明:
当前版本仅支持使用 npm 进行包管理与服务器运行。(npx支持将在后续版本中重新引入)
环境要求
- Node.js(推荐v14及以上版本)
- npm
详细安装指南
1. 克隆仓库
从指定源克隆仓库,例如:
bash
git clone https://github.com/makafeli/n8n-workflow-builder.git
进入项目目录:
bash
cd /root/n8n-workflow-builder
2. 安装依赖
使用npm安装必要依赖:
bash
npm install
该命令将根据package.json
文件定义下载并安装所有依赖包。
3. 构建与测试
使用以下命令进行测试并启动服务器:
-
项目构建:
编译TypeScript文件并在build
目录生成可执行JavaScript文件bashnpm run build
-
启动MCP服务器:
运行以下命令启动服务:bashnpm start
服务器启动后将通过stdio建立连接,可通过控制台消息确认服务是否正常启动。
4. 部署流程
测试环境下推荐使用上述构建与启动命令。当前推荐的基础部署流程为:安装→构建→启动。
5. 附加配置
服务器配置通过cline_mcp_settings.json
文件管理,请确保以下环境变量正确设置:
N8N_HOST
: n8n API主机地址N8N_API_KEY
: n8n API密钥
cline_mcp_settings.json
配置示例:
json
{
"n8n-workflow-builder": {
"command": "node",
"args": ["/root/n8n-workflow-builder/build/index.js"],
"env": {
"N8N_HOST": "https://n8n.io/api/v1/",
"N8N_API_KEY": "YOUR_N8N_API_KEY_HERE"
},
"disabled": false,
"alwaysAllow": [
"create_workflow",
"create_workflow_and_activate",
"update_workflow",
"activate_workflow",
"deactivate_workflow",
"get_workflow",
"delete_workflow"
],
"autoApprove": []
}
}
功能特性
MCP工具集
服务器预定义以下工具,可通过MCP客户端调用:
工作流管理
- list_workflows: 列出n8n中所有工作流
- create_workflow: 创建新工作流
- get_workflow: 根据ID获取工作流详情
- update_workflow: 更新现有工作流
- delete_workflow: 根据ID删除工作流
- activate_workflow: 激活指定工作流
- deactivate_workflow: 停用指定工作流
执行管理
- list_executions: 列出所有工作流执行记录(支持过滤)
- get_execution: 获取特定执行记录详情
- delete_execution: 删除指定执行记录
MCP资源
服务器提供以下资源以实现高效上下文访问:
静态资源
- /workflows: n8n实例中所有可用工作流列表
- /execution-stats: 工作流执行统计摘要
动态资源模板
- /workflows/{id}: 特定工作流详细信息
- /executions/{id}: 特定执行记录详细信息
故障排查
- 确认使用npm(当前版本不支持npx)
- 如遇问题,可尝试清理构建目录后重新构建:
bash
npm run clean && npm run build
- 检查
cline_mcp_settings.json
中的环境变量配置是否正确
未来规划
- 重新引入npx支持
- 新增工作流管理工具与特性
- 优化部署与扩展能力
许可协议
本项目采用MIT许可证。