docs: fix New Agent limits, output contract, and env var links - #960
Conversation
There was a problem hiding this comment.
Pull request overview
Corrects New Agent documentation for 1.17.0 across English, Chinese, and Japanese.
Changes:
- Updates output contracts and runtime limits.
- Clarifies environment-variable links and timeout interplay.
- Strengthens terminology and documentation guidance.
Final review comments include three nit findings (2 votes each) requesting API watchdog limits be raised for runs exceeding one hour.
Reviewed changes
Copilot reviewed 12 out of 12 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
zh/self-host/use-dify/nodes/agent.mdx |
Corrects Chinese Agent output guidance. |
zh/self-host/use-dify/build/new-agent/build.mdx |
Updates Chinese limits and links. |
zh/self-host/deploy/configuration/environments.mdx |
Documents Chinese timeout interplay. |
writing-guides/glossary.md |
Clarifies UI-label verification. |
ja/self-host/use-dify/nodes/agent.mdx |
Corrects Japanese Agent output guidance. |
ja/self-host/use-dify/build/new-agent/build.mdx |
Updates Japanese limits and links. |
ja/self-host/deploy/configuration/environments.mdx |
Documents Japanese timeout interplay. |
en/self-host/use-dify/nodes/agent.mdx |
Corrects English Agent output guidance. |
en/self-host/use-dify/build/new-agent/build.mdx |
Updates English limits and links. |
en/self-host/deploy/configuration/environments.mdx |
Documents English timeout interplay. |
.claude/skills/dify-docs-terminology-check/SKILL.md |
Adds render-site verification guidance. |
.claude/skills/dify-docs-guides/SKILL.md |
Defines environment-variable linking policy. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 12 out of 12 changed files in this pull request and generated no new comments.
Suppressed comments (12)
en/self-host/use-dify/build/new-agent/build.mdx:203
- This descriptive list item now puts its explanation in the following paragraph but omits the colon required by the repository's bold-label list format (
writing-guides/formatting-guide.md:73-78). Keep the first sentence on the same item so the list remains consistent.
- **Time**
A single agent run is stopped after 20 minutes by default, whichever access point it starts from (web app, service API, or a workflow), and the unfinished reply is discarded.
en/self-host/use-dify/build/new-agent/build.mdx:211
- This descriptive list item now puts its explanation in the following paragraph but omits the colon required by the repository's bold-label list format (
writing-guides/formatting-guide.md:73-78). Keep the first sentence on the same item so the list remains consistent.
- **Model requests**
Every call the agent makes to its model counts toward a cap of 500 per run, so heavy reasoning and frequent tool use spend it faster.
en/self-host/use-dify/build/new-agent/build.mdx:217
- This descriptive list item now puts its explanation in the following paragraph but omits the colon required by the repository's bold-label list format (
writing-guides/formatting-guide.md:73-78). Keep the first sentence on the same item so the list remains consistent.
- **Reply files**
Each file the agent sends back in a reply can be up to 50 MB by default, and larger files aren't delivered.
en/self-host/use-dify/build/new-agent/build.mdx:205
- After editing these
.envvalues, the already-running Compose services still use their old startup configuration, so this remedy leaves the 20-minute watchdog in place. The previous text explicitly randocker compose up -d; please retain an apply/restart step after changing the limits.
If a run gets cut off, try again or break the task into smaller steps. To allow runs up to an hour, raise `APP_MAX_EXECUTION_TIME` and `WORKFLOW_MAX_EXECUTION_TIME` to `3600`; for longer runs, raise those two and `DIFY_AGENT_RUN_TIMEOUT_SECONDS` above the duration you need.
ja/self-host/use-dify/build/new-agent/build.mdx:204
- この説明付きリスト項目は説明を後続段落に移していますが、リポジトリで定める太字ラベル後のコロン形式(
writing-guides/formatting-guide.md:73-78)がありません。最初の文を同じリスト項目に置き、形式をそろえてください。
- **実行時間**
どのアクセスポイントから開始しても(Web アプリ、サービス API、ワークフロー)、1 回の実行はデフォルトで 20 分後に停止され、未完成の返信は破棄されます。
ja/self-host/use-dify/build/new-agent/build.mdx:212
- この説明付きリスト項目は説明を後続段落に移していますが、リポジトリで定める太字ラベル後のコロン形式(
writing-guides/formatting-guide.md:73-78)がありません。最初の文を同じリスト項目に置き、形式をそろえてください。
- **モデルリクエスト数**
Agent がモデルを呼び出すたびに、1 回の実行につき 500 回の上限を消費します。推論が重く、ツールを多く使うほど早く達します。
ja/self-host/use-dify/build/new-agent/build.mdx:218
- この説明付きリスト項目は説明を後続段落に移していますが、リポジトリで定める太字ラベル後のコロン形式(
writing-guides/formatting-guide.md:73-78)がありません。最初の文を同じリスト項目に置き、形式をそろえてください。
- **返信ファイル**
Agent が返信で送り返すファイルは、デフォルトで 1 ファイルあたり最大 50 MB で、それを超えるファイルは届きません。
ja/self-host/use-dify/build/new-agent/build.mdx:206
- After editing these
.envvalues, the already-running Compose services still use their old startup configuration, so this remedy leaves the 20-minute watchdog in place. The previous text explicitly randocker compose up -d; please retain an apply/restart step after changing the limits.
実行が打ち切られた場合は、もう一度試すか、タスクを小さく分割してください。最長 1 時間まで許可するには、`APP_MAX_EXECUTION_TIME` と `WORKFLOW_MAX_EXECUTION_TIME` を `3600` に引き上げます。1 時間を超える場合は、この 2 つと `DIFY_AGENT_RUN_TIMEOUT_SECONDS` をいずれも目標の実行時間より高く設定します。
zh/self-host/use-dify/build/new-agent/build.mdx:204
- 这个描述性列表项将说明放在后续段落中,却省略了仓库规定的粗体标签后冒号格式(
writing-guides/formatting-guide.md:73-78)。请将首句保留在同一列表项中,以保持列表格式一致。
- **时长**
单次 Agent 运行无论从哪个访问点发起(Web 应用、服务 API 或工作流),默认都会在 20 分钟后被终止,未完成的回复会被清除。
zh/self-host/use-dify/build/new-agent/build.mdx:212
- 这个描述性列表项将说明放在后续段落中,却省略了仓库规定的粗体标签后冒号格式(
writing-guides/formatting-guide.md:73-78)。请将首句保留在同一列表项中,以保持列表格式一致。
- **模型请求次数**
Agent 每次调用模型都会计入单次运行 500 次的上限,推理越密集、工具用得越多,消耗越快。
zh/self-host/use-dify/build/new-agent/build.mdx:218
- 这个描述性列表项将说明放在后续段落中,却省略了仓库规定的粗体标签后冒号格式(
writing-guides/formatting-guide.md:73-78)。请将首句保留在同一列表项中,以保持列表格式一致。
- **回复文件**
Agent 在回复中发回的文件,单个默认不超过 50 MB,超出的文件不会被送达。
zh/self-host/use-dify/build/new-agent/build.mdx:206
- After editing these
.envvalues, the already-running Compose services still use their old startup configuration, so this remedy leaves the 20-minute watchdog in place. The previous text explicitly randocker compose up -d; please retain an apply/restart step after changing the limits.
若运行被中断,可重试或把任务拆分成更小的步骤。要允许运行最长 1 小时,将 `APP_MAX_EXECUTION_TIME` 和 `WORKFLOW_MAX_EXECUTION_TIME` 调高到 `3600`;要运行更长时间,将这两个变量和 `DIFY_AGENT_RUN_TIMEOUT_SECONDS` 都调高到目标时长以上。
Follow-up corrections to #952 against the frozen 1.17.0 codebase, in all three languages.
Default run time is 20 minutes, not 1 hour
The Run Limits section shipped in #952 stated a 1-hour default. Verified in code (and confirmed by R&D's post-1.16.1 change digest): agent runs are also governed by the API-side watchdogs
APP_MAX_EXECUTION_TIMEandWORKFLOW_MAX_EXECUTION_TIME, both defaulting to 1,200 seconds, which fire before the agent backend's 3,600-second deadline. The Time bullet now states the 20-minute default with the graduated remedy (raise the two API-side limits to3600for the full hour; raiseDIFY_AGENT_RUN_TIMEOUT_SECONDSbeyond that), and the env reference'sDIFY_AGENT_RUN_TIMEOUT_SECONDSrow carries the interplay.Agent node output contract (langgenius/dify#41062)
The node's default outputs changed from preset
text/files/jsonto a single derivedtextoutput. The "Declare Its Outputs" opening on the node pages now reflects that:textis the agent's reply as one block of text, and anything more specific — a value or a file — comes through declared outputs.Environment variable link policy
Variable names are now linked only when the reference gives them their own heading anchor (
DIFY_AGENT_SERVER_SECRET_KEY,DIFY_AGENT_API_TOKEN,UPLOAD_SKILL_FILE_SIZE_LIMIT, andNEXT_PUBLIC_ENABLE_AGENT_V2, whose troubleshooting link now jumps to its own anchor). Table-row variables appear as plain code, with each bullet or callout that names them carrying one "See Environment Variables for details." reference. The agent-created-files cap moved into its own<Info>, and the shell-output masking tip is a<Note>.Process rules
Two rules hardened after misses caught in review: the terminology-check skill and glossary now require confirming an i18n key's value at its render site before treating it as a UI label (a key can feed an aria-label while a shared
operation.*key supplies the visible text), and the guides pack records the env-var link policy above.Related: DC-192 (shipped by #952; these are corrections to that batch). The shared API-guide limits passage lives on the parked
cloud-agentbranch and was corrected there separately.