n8n 中文文档

使用 AI 构建

本页列出了 AI 编码代理为你的 n8n 实例编写 Workflow SDK 代码所需的内容,以及使用这些内容的顺序。你可以让代理阅读本页,或将表格粘贴到它的指令中。

需要连接什么

资源 位置 用途
n8n MCP 服务器 你的实例,请参阅连接到 n8n MCP 服务器 下面列出的构建器工具,以及实例上的工作流、执行和凭据管理
GitBook 文档 MCP 服务器 https://docs.n8n.io/~gitbook/mcp 搜索和阅读 n8n 文档,请参阅连接到 n8n docs MCP server
Kapa.ai 文档 MCP 服务器 https://n8n.mcp.kapa.ai 仅靠文档无法回答的问题:论坛帖子和博客文章
Markdown 格式的文档 在任意文档 URL 后添加 .md,或获取 https://docs.n8n.io/llms.txt 作为索引 不经 HTML 直接阅读页面
n8n CLI skill n8n-cli skill install --global,请参阅 n8n CLI 无需 MCP 服务器,在终端中以 JSON 管理工作流

SDK 本身以 @n8n/workflow-sdk package 的形式内置于 n8n 中,你的代理无需安装它。

构建器工具

n8n MCP 服务器上的这些工具用于读取和写入 Workflow SDK 代码。参数和输出请参阅 MCP 服务器工具参考。除非表中另有说明,这些工具从 n8n 2.12.0 起可用。

工具 返回内容
get_workflow_sdk_reference SDK 参考:import 语句、模式、表达式、函数、规则、指南和设计建议。请首先调用它。
get_workflow_best_practices 某一种工作流技巧的指南,例如 chatbot 或 data_extraction。传入 list 可查看所有技巧。从 n8n 2.26.0 起可用。
search_nodes 根据服务名称或任务,返回节点 id 以及节点所需的 resource 或 operation 值。
get_node_types 你计划使用的节点的 TypeScript 类型定义及其参数。
explore_node_resources 节点的实时选项,例如某个 Slack 凭据可以看到的频道。从 n8n 2.27.0 起可用。
validate_node_config 根据 schema 检查单个节点的配置。从 n8n 2.25.1 起可用。
validate_workflow 检查整个文件。代码无效时会返回错误和提示。
create_workflow_from_code 将已验证的代码保存为新工作流,并返回其 URL。
update_workflow 对现有工作流应用一批按顺序排列的部分更改,例如 addNode、updateNodeParameters 或 addConnection。它不接受新文件。

有效的使用顺序

跳过参考的代理会去猜测语法,并在验证错误上反复循环。请给你的代理提供以下步骤:

  1. 调用 get_workflow_sdk_reference。阅读 patterns 部分,找到与任务匹配的结构。
  2. 如果有适用的技巧,且实例运行 n8n 2.26.0 或更高版本,调用 get_workflow_best_practices 获取该技巧。
  3. 针对工作流所需的每个节点,先调用 search_nodes,再调用 get_node_types。
  4. 编写文件。先声明节点,最后组合工作流,只使用一个 export default。
  5. 调用 validate_workflow。按照 hint 的提示修复问题。重复此步骤,直到 valid 为 true。
  6. 调用 create_workflow_from_code。对于现有工作流,使用 operations 数组调用 update_workflow。
  7. 在报告成功之前,运行一次工作流,并使用 get_workflow_execution 读取执行结果。

警告

create_workflow_from_code 会保存工作流,但不会发布它。在触发器能够触发之前,请在编辑器中发布工作流,或调用 publish_workflow。

可以直接使用的提示词

将以下内容粘贴给你的代理,并修改最后一句:

You build n8n workflows as Workflow SDK code through the n8n MCP server.
Before writing code, call get_workflow_sdk_reference and read the patterns section.
For each node, call search_nodes and get_node_types to get the exact type id, version, and parameter names.
Write one file with export default workflow(...). Call validate_workflow and fix every error until valid is true.
Then call create_workflow_from_code and return the workflow URL.
Task: build a workflow that ...

相关资源

不想自己部署和维护 n8n?n8ncn 托管 n8n 云服务:开通账号即可使用,不用买服务器;也可以在 n8ncn 工作流库 找现成的中文工作流。