使用说明

项目简介

n8n Workflow Builder MCP Server 是一个基于 Model Context Protocol (MCP) 构建的服务器端应用，它充当 MCP 客户端和 n8n 工作流自动化平台之间的桥梁。通过此服务器，MCP 客户端能够以标准化的方式管理和控制 n8n 平台上的工作流，实现更灵活和强大的自动化流程编排。

主要功能点

工作流管理:
- 列出工作流: 获取 n8n 平台上的所有工作流列表。
- 创建工作流: 在 n8n 平台上创建新的工作流。
- 获取工作流: 根据 ID 获取指定工作流的详细信息。
- 更新工作流: 修改已存在的工作流。
- 删除工作流: 根据 ID 删除指定工作流。
- 激活/停用工作流: 激活或停用指定 ID 的工作流。
执行管理:
- 列出执行记录: 获取工作流执行的历史记录，并支持过滤。
- 获取执行详情: 根据 ID 获取指定执行记录的详细信息。
- 删除执行记录: 根据 ID 删除指定的执行记录。
资源访问:
- /workflows: 提供 n8n 中所有工作流的列表资源。
- /workflows/{id}: 提供特定 ID 工作流的详细信息资源。
- /execution-stats: 提供工作流执行统计信息的资源。
- /executions/{id}: 提供特定 ID 执行记录的详细信息资源。

安装步骤

克隆仓库

git clone https://github.com/makafeli/n8n-workflow-builder.git
cd n8n-workflow-builder

安装依赖
```
npm install
```
构建项目
```
npm run build
```
启动服务器
```
npm start
```

服务器配置

MCP 客户端需要配置服务器的启动信息以连接到 n8n Workflow Builder MCP Server。以下是一个 'cline_mcp_settings.json' 文件的配置示例，展示了如何配置此服务器：

{
  "n8n-workflow-builder": {
    "command": "node",
    "args": ["/path/to/n8n-workflow-builder/build/index.js"],
    "env": {
      "N8N_HOST": "YOUR_N8N_HOST_URL",  // 替换为你的 n8n API Host URL，例如 "https://n8n.example.com/api/v1/"
      "N8N_API_KEY": "YOUR_N8N_API_KEY"   // 替换为你的 n8n API Key
    },
    "disabled": false,
    "alwaysAllow": [ /* 这里配置默认允许执行的工具，例如工作流管理工具 */
      "list_workflows",
      "create_workflow",
      "get_workflow",
      "update_workflow",
      "delete_workflow",
      "activate_workflow",
      "deactivate_workflow",
      "list_executions",
      "get_execution",
      "delete_execution"
    ],
    "autoApprove": []
  }
}

配置参数说明:

'server name': 服务器名称，例如 "n8n-workflow-builder"。
'command': 启动服务器的命令，这里是 "node"，表示使用 Node.js 运行时。
'args': 传递给 'command' 的参数，指向编译后的服务器入口文件 '/path/to/n8n-workflow-builder/build/index.js'，请根据实际路径修改。
'env': 环境变量配置，包含了连接 n8n API 所需的信息：
- 'N8N_HOST': 必填，你的 n8n API Host URL，需要包含 API 版本路径，例如 "https://n8n.example.com/api/v1/"。
- 'N8N_API_KEY': 必填，用于 API 鉴权的 n8n API Key。
'disabled': 是否禁用该服务器，'false' 表示启用。
'alwaysAllow': 配置客户端默认允许调用的工具名称列表，无需用户额外授权即可执行。
'autoApprove': 配置客户端自动批准的工具名称列表，调用这些工具时无需用户确认。

注意: 请将 '/path/to/n8n-workflow-builder' 替换为 n8n-workflow-builder 仓库在您服务器上的实际路径，并将 'YOUR_N8N_HOST_URL' 和 'YOUR_N8N_API_KEY' 替换为您的 n8n 实例的真实信息。

基本使用方法

配置完成后，MCP 客户端即可连接到此服务器。客户端可以通过 JSON-RPC 协议调用服务器提供的工具 (Tools) 和访问资源 (Resources) 来管理 n8n 工作流。例如，客户端可以调用 'list_workflows' 工具来获取工作流列表，或调用 'create_workflow' 工具来创建新的工作流。具体工具和资源的使用方法请参考 MCP 协议文档和服务器提供的工具/资源描述信息。

关键词