使用说明
n8n工作流生成器MCP服务器
n8n工作流自动化的终极AI助手集成 -将Claude Desktop、ChatGPT和其他AI助手直接连接到n8n实例,通过模型上下文协议(MCP)实现无缝的工作流管理、创建和执行。
强大的模型上下文协议(MCP)服务器,使AI助手能够无缝管理n8n工作流。将您的AI工具直接连接到n8n,以实现自动化的工作流创建、执行和管理。
📚 目录
📖 其他文件
- 🚀 入门指南 -5分钟内快速设置
- 💼 真实世界用例 -电子商务、数据处理、API集成等
- 🔍 与备选方案的比较 -与Zapier、Make.com、n8n Web UI和CLI相比
- 🔧 全面故障排除 -常见问题的解决方案
🎯 这是什么?
n8n Workflow Builder MCP Server弥合了AI助手(如Claude Desktop、Cline或任何兼容MCP的客户端)与n8n自动化平台之间的差距。它提供了一套全面的工具,使AI助手能够:
- 列表和浏览 您现有的n8n工作流
- 创建新工作流 具有复杂的节点配置
- 执行工作流 按需
- 管理工作流生命周期 (激活、停用、更新、删除)
- 监控工作流状态 并检索详细信息
非常适合使用n8n的团队,他们希望利用AI助手进行工作流自动化和管理。
✨ 主要特点
- 🔧 完整的工作流管理 -n8n工作流的完整CRUD操作
- 🤖 AI优先设计 -专为AI助手集成而构建
- 🚀 零配置 -与NPX一起开箱即用
- 🔒 安全 -使用n8n的官方API并进行正确的身份验证
- 📦 现代建筑 -使用TypeScript和最新的MCP SDK构建
- ⚡ 高性能 -针对快速响应时间进行了优化
📋 需求
- Node.js v18.0.0或更高版本
- n8n实例 (自托管或云)
- n8n API密钥 具有适当的权限
🚀 安装与使用
方法1:Smithery.ai(托管-推荐)
使用Smithery.ai上的托管版本-无需安装:
- 访问: 史密斯艾
- 搜索:“n8n工作流生成器”
- 连接:使用n8n主机和API密钥进行配置
- 使用:从任何兼容MCP的AI助手访问
益处:无需本地设置,自动更新,专业托管,工具游乐场。
方法2:NPX(本地)
使用NPX在本地运行:
npx @makafeli/n8n-workflow-builder
方法2:手动安装
对于开发或定制:
# Clone the repository
git clone https://github.com/makafeli/n8n-workflow-builder.git
cd n8n-workflow-builder
# Install dependencies
npm install
# Build the project
npm run build
# Start the server
npm start
⚙️ 配置
环境变量
配置以下环境变量以连接到n8n实例:
| 变量 | 描述 | 示例 |
|---|---|---|
N8N_HOST |
您的n8n实例URL | http://localhost:5678 或 https://your-n8n.com/api/v1 |
N8N_API_KEY |
您的n8n API密钥 | n8n_api_1234567890abcdef... |
获取n8n API密钥
- 打开n8n实例
- 首选 设置 → API密钥
- 点击 创建API密钥
- 复制生成的密钥
设置环境变量
# For local testing
export N8N_HOST="http://localhost:5678"
export N8N_API_KEY="your-api-key-here"
# Then run the server
npx @makafeli/n8n-workflow-builder
🔧 MCP客户端设置
克劳德桌面
将此配置添加到您的 claude_desktop_config.json:
{
"mcpServers": {
"n8n-workflow-builder": {
"command": "npx",
"args": ["@makafeli/n8n-workflow-builder"],
"env": {
"N8N_HOST": "http://localhost:5678",
"N8N_API_KEY": "your-api-key-here"
}
}
}
}
Cline(VS代码扩展)
将此添加到您的Cline MCP设置中:
{
"mcpServers": {
"n8n-workflow-builder": {
"command": "npx",
"args": ["@makafeli/n8n-workflow-builder"],
"env": {
"N8N_HOST": "http://localhost:5678",
"N8N_API_KEY": "your-api-key-here"
}
}
}
}
其他MCP客户端
服务器可与任何兼容MCP的客户端配合使用。将相同的配置模式用于客户端的特定设置方法。
🛠️ 可用工具
MCP服务器为完整的n8n工作流和执行管理提供了15个全面的工具:
核心工作流操作
| 工具 | 说明 | 参数 |
|---|---|---|
list_workflows |
列出n8n实例中的所有工作流 | 无 |
get_workflow |
检索特定工作流的详细信息 | id:工作流ID(字符串) |
create_workflow |
使用节点和连接创建新的工作流 | workflow:工作流对象 |
execute_workflow |
手动执行工作流 | id:工作流ID(字符串) |
工作流生命周期管理
| 工具 | 说明 | 参数 |
|---|---|---|
update_workflow |
更新现有工作流的配置 | id:工作流ID, workflow:已更新工作流对象 |
activate_workflow |
激活工作流以启用自动执行 | id:工作流ID(字符串) |
deactivate_workflow |
停用工作流以停止自动执行 | id:工作流ID(字符串) |
delete_workflow |
永久删除工作流 | id:工作流ID(字符串) |
高级操作
| 工具 | 说明 | 参数 |
|---|---|---|
create_workflow_and_activate |
创建新工作流并立即激活 | workflow:工作流对象 |
执行管理⭐ 新
| 工具 | 说明 | 参数 |
|---|---|---|
list_executions |
列出具有过滤和分页功能的工作流执行情况 | includeData, status, workflowId, projectId, limit, cursor |
get_execution |
获取特定执行的详细信息 | id:执行ID, includeData:包括详细数据 |
delete_execution |
删除工作流执行记录 | id:执行ID |
标签管理⭐ 新
| 工具 | 说明 | 参数 |
|---|---|---|
list_tags |
列出所有带有分页的工作流标签 | limit, cursor |
create_tag |
为组织创建新的工作流标记 | name:标签名称 |
安全与合规⭐ 新
| 工具 | 说明 | 参数 |
|---|---|---|
generate_audit |
生成全面的安全审计报告 | additionalOptions:审核配置 |
💡 使用示例
基本操作
// List all workflows
await callTool("list_workflows", {});
// Get detailed information about a workflow
await callTool("get_workflow", { id: "workflow-123" });
// Execute a workflow manually
await callTool("execute_workflow", { id: "workflow-123" });
创建工作流
// Create a simple workflow
await callTool("create_workflow", {
workflow: {
name: "My Automation Workflow",
nodes: [
{
id: "trigger",
name: "Schedule Trigger",
type: "n8n-nodes-base.scheduleTrigger",
typeVersion: 1,
position: [240, 300],
parameters: {
interval: [{ field: "unit", value: "hours" }]
}
},
{
id: "action",
name: "HTTP Request",
type: "n8n-nodes-base.httpRequest",
typeVersion: 4,
position: [460, 300],
parameters: {
url: "https://api.example.com/webhook",
method: "POST"
}
}
],
connections: {
"Schedule Trigger": {
"main": [[{ "node": "HTTP Request", "type": "main", "index": 0 }]]
}
}
}
});
工作流管理
// Activate a workflow
await callTool("activate_workflow", { id: "workflow-123" });
// Update a workflow
await callTool("update_workflow", {
id: "workflow-123",
workflow: { name: "Updated Workflow Name" }
});
// Deactivate a workflow
await callTool("deactivate_workflow", { id: "workflow-123" });
// Create and immediately activate
await callTool("create_workflow_and_activate", {
workflow: { /* workflow configuration */ }
});
执行管理⭐ 新
// List recent executions
await callTool("list_executions", {
limit: 10,
status: "error"
});
// Get detailed execution information
await callTool("get_execution", {
id: "execution-123",
includeData: true
});
// Clean up old execution records
await callTool("delete_execution", { id: "execution-123" });
标签管理⭐ 新
// List all workflow tags
await callTool("list_tags", { limit: 50 });
// Create a new tag for organization
await callTool("create_tag", { name: "production" });
安全审计⭐ 新
// Generate comprehensive security audit
await callTool("generate_audit", {
additionalOptions: {
daysAbandonedWorkflow: 30,
categories: ["credentials", "database", "nodes"]
}
});
🔧 故障排除
常见问题
“连接被拒绝”或“ECONNREFUSED”
- 原因:无法连接到n8n实例
- 解决方案:验证您的
N8N_HOST正确,n8n正在运行 - 检查:请先尝试在浏览器中访问n8n实例
“未经授权”或“401错误”
- 原因:API密钥无效或丢失
- 解决方案:
- 验证您的
N8N_API_KEY是正确的 - 确保API密钥具有正确的权限
- 检查API密钥是否尚未过期
- 验证您的
“找不到工作流”或“404错误”
- 原因:工作流ID不存在
- 解决方案:使用
list_workflows获取有效的工作流ID
服务器无法启动
- 原因:缺少Node.js或依赖项
- 解决方案:
- 确保已安装Node.js v18+:
node --version - 尝试清除npm缓存:
npm cache clean --force - 对于手动安装,请运行:
npm install && npm run build
- 确保已安装Node.js v18+:
调试模式
有关详细的日志记录,请设置调试环境变量:
DEBUG=n8n-workflow-builder npx @makafeli/n8n-workflow-builder
获取帮助
❓ 常见问题
什么是MCP服务器?
A. 模型上下文协议(MCP)服务器 是AI助手访问外部工具和数据源的标准化方式。此MCP服务器专门为AI助手提供与n8n工作流交互的能力,通过自然语言命令实现自动化工作流管理。
如何将AI助手连接到n8n工作流?
此MCP服务器充当AI助手(如Claude Desktop、Cline或ChatGPT)和n8n实例之间的桥梁。简单地说:
- 安装MCP服务器:
npx @makafeli/n8n-workflow-builder - 使用n8n凭据配置AI助手的MCP设置
- 开始使用自然语言管理n8n工作流
哪些AI助手与此MCP服务器配合使用?
服务器可以与任何 MCP兼容AI助手,包括:
- 克劳德桌面 (人类学)
- 克莱恩 (VS代码扩展)
- 继续 (VS代码扩展)
- 任何自定义MCP客户端实现
- 未来兼容MCP的人工智能助手
我可以将其与n8n Cloud一起使用,还是只使用自托管?
此MCP服务器与 n8n云和自托管实例。您只需要:
- 您的n8n实例URL(云或自托管)
- 具有适当权限的有效n8n API密钥
- 从运行MCP服务器的位置进行网络访问
AI助手可以用我的n8n工作流做什么?
AI助手可以执行 完整的工作流管理 包括:
- 列表和浏览 现有工作流
- 创建新工作流 具有复杂的节点配置
- 执行工作流 手动或按需
- 激活/停用 工作流
- 更新和修改 现有工作流
- 监控执行状态 并检索详细日志
- 管理工作流标签 和组织
- 生成安全审核 以及合规报告
这安全吗?它需要什么权限?
MCP服务器使用 n8n的官方API 通过适当的身份验证:
- 需要有效的n8n API密钥(由您控制权限)
- MCP服务器不存储任何数据
- 您的AI助手和n8n之间的所有通信都是直接的
- 遵循n8n的安全模型和访问控制
- 您可以通过禁用API密钥随时撤销访问权限
这与使用n8n的web界面有何不同?
此MCP服务器启用 人工智能驱动的工作流管理:
- 自然语言命令 而不是点击UI
- 自动创建工作流 基于描述
- 批量操作 跨多个工作流
- 与AI助手工作流程集成 以及自动化
- 语音命令 通过AI助手
- 上下文帮助 以及AI的建议
🔍 详细比较:查看我们的 比较指南 以获取与n8n Web UI、CLI、Zapier和Make.com的详细比较。
我可以用AI自动创建工作流吗?
对!这是关键特征之一。你可以:
- 用自然语言描述工作流程 让人工智能创造它们
- 根据需求生成工作流 或用例
- 修改现有工作流 通过对话命令
- 创建工作流模板 自动变化
- 批量创建类似工作流 具有不同的参数
💼 真实案例:查看我们的 用例指南 了解不同行业的具体自动化示例。
如果我遇到问题或错误怎么办?
常见解决方案:
- 检查n8n API密钥 -确保其有效并具有适当的权限
- 验证n8n实例URL -确保它可访问且正确
- 查看故障排除部分 以上为特定错误消息
- 检查GitHub问题 已知问题和解决方案
- 启用调试模式 随着
DEBUG=n8n-workflow-builder查看详细日志
🔧 全面帮助:查看我们的 故障排除指南 了解常见问题的详细解决方案。
我如何快速开始?
最快的设置:
- 使用Smithery.ai托管版本 (无需安装): 史密斯艾
- 或在本地运行:
npx @makafeli/n8n-workflow-builder - 配置您的AI助手 使用您的n8n凭据
- 从简单的命令开始 例如“列出我的工作流”或“显示工作流详细信息”
📖 详细指南:查看我们的 入门指南 有关分步设置说明。
我可以贡献或自定义此MCP服务器吗?
当然!这是一个 开源项目:
- 分叉存储库 用于自定义
- 提交拉取请求 改进
- 报告问题 或在GitHub上请求功能
- 扩展功能 通过添加新的MCP工具
- 共享用例 以及社区的例子
🤝 贡献
我们欢迎捐款!
📄 许可证
此项目根据MIT许可证获得许可-请参阅 许可证 文件以获取详细信息。
🔗 实用链接
内置于❤️ 适用于n8n和MCP社区
{
"@context": "https://schema.org",
"@type": "SoftwareApplication",
"name": "n8n Workflow Builder MCP Server",
"description": "AI assistant integration for n8n workflow automation through the Model Context Protocol (MCP). Connect Claude Desktop, ChatGPT, and other AI assistants to n8n for natural language workflow management.",
"url": "https://github.com/makafeli/n8n-workflow-builder",
"downloadUrl": "https://www.npmjs.com/package/@makafeli/n8n-workflow-builder",
"applicationCategory": "DeveloperApplication",
"operatingSystem": "Cross-platform",
"programmingLanguage": "TypeScript",
"author": {
"@type": "Person",
"name": "makafeli",
"url": "https://github.com/makafeli"
},
"license": "https://github.com/makafeli/n8n-workflow-builder/blob/main/LICENSE",
"keywords": [
"n8n",
"MCP",
"AI assistant",
"workflow automation",
"Claude Desktop",
"ChatGPT",
"Model Context Protocol"
],
"offers": {
"@type": "Offer",
"price": "0",
"priceCurrency": "USD"
},
"softwareRequirements": "Node.js 18.0.0 or higher",
"releaseNotes": "https://github.com/makafeli/n8n-workflow-builder/releases",
"codeRepository": "https://github.com/makafeli/n8n-workflow-builder"
}
