mcp-n8n-builder

一个用于程序化创建和管理 n8n 工作流的模型上下文协议 (MCP) 服务器。此服务器提供了与 n8n 的 REST API 交互的工具和资源，允许 AI 助手在无需用户直接干预的情况下构建、修改和管理工作流。

特性

• 🔄 工作流管理：创建、读取、更新、删除、激活和停用工作流
• 📊 执行管理：列出并检索工作流执行详情
• ✅ 模式验证：使用 Zod 对输入和输出数据进行全面验证
• 🔍 节点验证：在创建工作流之前，验证节点类型是否属于 n8n 可用节点，以防止错误
• 🤔 智能建议：当检测到无效节点时，提供相似节点类型的建议
• 🛠️ 错误处理：详细的错误消息以便于故障排除
• 📝 文档：所有工具和资源的详尽文档
• 🔍 搜索与过滤：按名称、标签或活动状态筛选工作流

配置

此服务器需要通过您的 MCP 客户端进行配置。以下是不同环境下的示例：

Cline 配置

将以下内容添加到您的 Cline MCP 设置中：

{
    "mcpServers": {
        "n8n-workflow-builder": {
            "command": "npx",
            "args": ["-y", "mcp-n8n-builder"],
            "env": {
                "N8N_HOST": "http://localhost:5678/api/v1",
                "N8N_API_KEY": "your-n8n-api-key",
                "OUTPUT_VERBOSITY": "concise" // Options: 'concise' or 'full'
            }
        }
    }
}

Claude Desktop with WSL 配置

对于 WSL 环境，请将以下内容添加到您的 Claude Desktop 配置中：

{
    "mcpServers": {
        "n8n-workflow-builder": {
            "command": "wsl.exe",
            "args": [
                "bash",
                "-c",
                "N8N_HOST=http://localhost:5678/api/v1 N8N_API_KEY=your-n8n-api-key OUTPUT_VERBOSITY=concise npx -y mcp-n8n-builder"
            ]
        }
    }
}

环境变量

服务器可以通过环境变量进行配置：

MCP 工具

节点管理

• list_available_nodes：列出 n8n 实例中的所有可用节点。重要：在创建或更新工作流之前使用此工具，以确保仅使用有效的节点类型。这有助于防止由于使用当前 n8n 实例中不存在的节点类型而导致的错误。

工作流管理

• list_workflows: 列出 n8n 中的所有工作流及其基本信息，包括 ID、名称、状态、创建日期和标签。结果可以根据活动状态、标签或名称进行过滤。
• create_workflow: 在 n8n 中使用指定的节点和连接创建一个新的工作流。返回已创建的工作流及其分配的 ID。验证所有节点类型是否存在于 n8n 实例中。
• get_workflow: 通过其 ID 检索特定工作流的完整详细信息，包括所有节点、连接、设置和元数据。
• update_workflow: 使用新配置更新现有工作流。必须提供整个工作流结构，而不仅仅是更改的部分。验证所有节点类型是否存在于 n8n 实例中。
• delete_workflow: 通过其 ID 永久删除一个工作流。此操作无法撤销。
• activate_workflow: 通过其 ID 激活一个工作流，使其能够根据触发器自动运行。
• deactivate_workflow: 通过其 ID 停用一个工作流，防止其自动运行。

执行管理

• list_executions: 列出工作流执行历史记录，并提供成功/失败状态、持续时间和时间戳等详细信息。结果可以根据工作流 ID、状态进行过滤，并限制为特定数量。
• get_execution: 检索关于特定工作流执行的详细信息，包括执行时间、状态，以及可选地在每个步骤中处理的完整数据。

MCP 资源

• n8n://workflows: n8n 中的所有工作流列表
• n8n://workflows/{id}: 特定 n8n 工作流的详细信息
• n8n://executions/{id}: 特定 n8n 工作流执行的详细信息

开发

设置

1. 克隆仓库
2. 安装依赖项：

npm install

1. 构建项目：

npm run build

1. 以开发模式运行：

npm run dev

发布

该项目使用 changesets 进行版本管理。要发布：

1. 创建一个 changeset：

npm changeset

1. 对包进行版本控制：

npm changeset version

1. 发布到 npm：

npm release

贡献

欢迎贡献！请随时提交 Pull Request。

许可证

MIT 许可证 - 有关详细信息，请参阅 LICENSE 文件。

致谢

• 基于 Model Context Protocol
• 由 n8n 提供支持