使用说明

项目简介

本项目 'n8n Workflow Builder MCP Server' 是一个基于 Model Context Protocol (MCP) 构建的服务器，旨在使 AI 助手能够以编程方式与 n8n 工作流自动化平台进行交互。通过提供一系列工具和资源，该服务器允许 AI 助手创建、管理和执行 n8n 工作流，从而实现更智能的自动化流程。

主要功能点

工作流管理: 支持创建、读取、更新、删除、激活和停用 n8n 工作流。
执行管理: 允许列出和检索 n8n 工作流的执行详情，方便监控和调试。
节点验证: 在创建或更新工作流时，验证节点类型是否在目标 n8n 实例中有效，避免因使用无效节点而导致的错误。
资源访问: 将 n8n 工作流和执行信息作为 MCP 资源提供，方便 AI 助手获取上下文信息。

安装步骤

克隆仓库

git clone https://github.com/spences10/mcp-n8n-builder.git

进入项目目录
```
cd mcp-n8n-builder
```
安装依赖
```
npm install
```
构建项目
```
npm run build
```

服务器配置

为了让 MCP 客户端能够连接到 'n8n Workflow Builder MCP Server'，您需要在 MCP 客户端的配置中添加以下服务器信息。这段 JSON 配置定义了一个名为 'n8n-workflow-builder' 的 MCP 服务器，并指定了启动该服务器所需的命令 ('command') 和参数 ('args')。环境变量 ('env') 用于配置服务器连接 n8n API 所需的信息。

{
	"mcpServers": {
		"n8n-workflow-builder": {
			"command": "npx",
			"args": ["-y", "mcp-n8n-builder"],
			"env": {
				"N8N_HOST": "http://localhost:5678/api/v1", // 【必填】n8n API 的 URL，请替换为您的 n8n 实例地址，默认为 http://localhost:5678/api/v1
				"N8N_API_KEY": "YOUR_N8N_API_KEY", // 【必填】n8n API 密钥，请替换为您的 n8n API 密钥
				"OUTPUT_VERBOSITY": "concise" // 【可选】输出详细程度，可选值：'concise'（简洁） 或 'full'（完整），默认为 'concise'，简洁模式更节省上下文窗口空间
			}
		}
	}
}

配置参数说明:

'command': 启动服务器的命令，这里使用 'npx' 来执行 'mcp-n8n-builder' 包。
'args': 传递给 'npx' 的参数，'-y' 表示自动确认安装 'mcp-n8n-builder' 包。
'env': 环境变量配置，用于设置服务器运行所需的参数：
- 'N8N_HOST': 必须配置，您的 n8n 实例 API 的 URL。
- 'N8N_API_KEY': 必须配置，用于访问 n8n API 的密钥。请在 n8n 中生成 API 密钥并替换 'YOUR_N8N_API_KEY'。
- 'OUTPUT_VERBOSITY': 可选配置，控制工具输出信息的详细程度。'concise' 模式下，输出信息更简洁，适合节省上下文窗口；'full' 模式下，输出更完整的信息，包括完整的 JSON 响应。默认为 'concise'。

请注意: 请务必将 'YOUR_N8N_API_KEY' 替换为您实际的 n8n API 密钥，并根据您的 n8n 实例地址配置 'N8N_HOST'。

基本使用方法

确保 n8n 实例已启动并可访问。
启动 'n8n Workflow Builder MCP Server' (通常由 MCP 客户端在后台自动启动，无需手动运行命令)。
在 MCP 客户端中，AI 助手可以通过以下方式与 n8n 工作流进行交互：
- 使用工具 (Tools): 通过调用预定义的工具，例如 'list_workflows'（列出工作流）、'create_workflow'（创建工作流）、'execute_workflow'（执行工作流）等，来管理和操作 n8n 工作流。
- 访问资源 (Resources): 通过资源 URI，例如 'n8n://workflows'（所有工作流列表）、'n8n://workflows/{id}'（特定工作流详情）等，获取 n8n 工作流的上下文信息。

请参考仓库的 README.md 文件和代码注释，了解更详细的工具和资源使用方法以及参数说明。

关键词