使用说明

项目简介

n8n 工作流 MCP 服务器是一个基于 Model Context Protocol (MCP) 构建的后端服务，旨在连接 AI 助手和 n8n 工作流自动化平台。通过此服务器，AI 助手可以以标准化的方式访问和控制 n8n 工作流，实现自动化流程的自然语言交互。

主要功能点

• 工作流管理：支持 AI 助手列出、查看、创建、更新、删除、激活和停用 n8n 工作流。
• 执行管理：允许 AI 助手运行 n8n 工作流、查看执行详情、列出执行记录和停止正在运行的执行。
• 资源访问：提供标准化的资源接口，例如工作流列表、工作流详情、执行列表和执行详情，供 AI 助手获取上下文信息。
• 工具集成：将 n8n 工作流操作封装为工具，方便 AI 助手通过工具调用执行特定功能。

安装步骤

1. 环境准备：

   • 确保已安装 Node.js 和 npm。
   • 访问 n8n Instance 获取 n8n 实例地址和 API 密钥。

2. 配置环境变量：

   • 在项目根目录下创建 '.env' 文件。
   • 根据您的 n8n 实例信息，配置以下环境变量：

     N8N_API_URL=https://yaama.app.n8n.cloud/api/v1 # 您的 n8n 实例 API 地址
     N8N_API_KEY=your-api-key              # 您的 n8n API 密钥
     DEBUG=true                             # 开启调试模式 (可选)
     

     请将 'your-api-key' 替换为您的实际 n8n API 密钥。

3. 启动服务器：

   • 确保 'start-mcp-server.sh' 文件具有执行权限 (可以使用 'chmod +x start-mcp-server.sh' 命令添加执行权限)。
   • 运行启动脚本：

     ./start-mcp-server.sh
     

     服务器将在后台启动。

服务器配置

以下 JSON 配置信息用于 MCP 客户端连接到 n8n 工作流 MCP 服务器。请根据实际情况配置到您的 MCP 客户端。

{
  "serverName": "n8n Workflow MCP Server",
  "command": "./start-mcp-server.sh",
  "args": []
}

• 'serverName': 服务器名称，用于在 MCP 客户端中标识该服务器，可以自定义。
• 'command': 启动 MCP 服务器的命令，指向 'start-mcp-server.sh' 脚本的路径。
• 'args': 启动命令的参数，本例中不需要额外参数，所以为空数组。

基本使用方法

1. 注册 MCP 服务器: 在您的 AI 助手平台或 MCP 客户端中，按照其提供的指引，注册上述服务器配置信息。

2. AI 助手交互: 注册成功后，您的 AI 助手即可通过 MCP 协议与 n8n 工作流 MCP 服务器进行通信。AI 助手可以使用自然语言调用服务器提供的工具和资源，例如：

   • "列出所有工作流" (对应 'workflow_list' 工具或 'n8n://workflows/list' 资源)
   • "运行名为 'Yaama - Recruitment Test Workflow' 的工作流" (可能需要先获取工作流 ID，然后调用 'execution_run' 工具)
   • "查看 ID 为 'workflow-123' 的工作流详情" (对应 'workflow_get' 工具或 'n8n://workflow/{id}' 资源)

   具体的交互方式和工具/资源调用方法，请参考您的 AI 助手平台和 MCP 客户端的文档。