article
README
🚀 n8n 工作流构建器 MCP 服务器
该项目提供了一个 MCP 服务器,用于管理 n8n 工作流。它具备列出、创建、更新、删除、激活和停用工作流的功能,为 n8n 工作流的管理提供了全面且便捷的解决方案。
⚠️ 重要提示
此版本仅支持使用 npm 进行包管理和运行服务器。(未来版本将重新引入对 npx 的支持。)
🚀 快速开始
本项目需要一定的环境条件才能顺利运行,同时按照特定步骤进行安装和配置,以下为您详细介绍。
📦 安装指南
1. 克隆仓库
从您选择的来源克隆仓库,示例命令如下:
git clone https://github.com/makafeli/n8n-workflow-builder.git
克隆完成后,进入项目目录:
cd /root/n8n-workflow-builder
2. 安装依赖项
使用 npm 安装必要的依赖项,此命令会下载并安装 package.json 文件中定义的所有所需包:
npm install
3. 构建和测试
为了测试并将服务器联机,需执行以下操作:
- 构建项目:编译 TypeScript 文件,并在
build目录中生成可执行的 JavaScript 文件。
npm run build
- 启动 MCP 服务器:使用以下命令启动服务器,服务器将启动并通过 stdio 连接,您可以在控制台查看确认服务器已正确启动的消息。
npm start
4. 部署
为了测试目的并将服务器联机,请使用上述构建和启动命令。此基本工作流程(安装、构建、启动)目前是推荐的方法。
5. 额外配置
服务器配置通过 cline_mcp_settings.json 文件管理。确保以下环境变量正确设置:
N8N_HOST:您的 n8n API 主机 URL。N8N_API_KEY:您的 n8n API 密钥。
以下是 cline_mcp_settings.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:在 n8n 中创建新工作流。
- get_workflow:根据 ID 获取工作流。
- update_workflow:更新现有工作流。
- delete_workflow:根据 ID 删除工作流。
- activate_workflow:根据 ID 激活工作流。
- deactivate_workflow:根据 ID 停用工作流。
执行管理
- list_executions:列出所有工作流执行,带有可选过滤器。
- get_execution:根据 ID 获取特定执行的详细信息。
- delete_execution:根据 ID 删除执行。
MCP 资源
服务器还提供以下资源,以实现更高效的上下文访问:
静态资源
- /workflows:n8n 实例中所有可用工作流的列表
- /execution-stats:工作流执行的汇总统计信息
动态资源模板
- /workflows/{id}:特定工作流的详细信息
- /executions/{id}:特定执行的详细信息
📚 详细文档
问题排除
- 确保使用 npm(此版本不支持 npx)。
- 如果遇到任何问题,请清理构建目录并重新构建:
npm run clean && npm run build
- 验证
cline_mcp_settings.json中的环境变量是否正确。
未来改进
- 重新引入对 npx 的支持。
- 添加更多工作流功能。
- 改进服务器性能和稳定性。
📄 许可证
[此处插入许可证信息]
贡献者
[此处列出贡献者]
链接
[此处添加相关链接]
微信扫一扫