workflow 5.0.0-beta.43 → 5.0.0-beta.44

package/README.md

@@ -8,9 +8,9 @@
   <h1>Workflow SDK</h1>
 
 <a href="https://vercel.com"><img alt="Vercel logo" src="https://img.shields.io/badge/MADE%20BY%20Vercel-000000.svg?style=for-the-badge&logo=Vercel&labelColor=000"></a>
-<a href="https://www.npmjs.com/package/workflow"><img alt="NPM version" src="https://img.shields.io/npm/v/workflow?style=for-the-badge&labelColor=000000"></a>
+<a href="https://www.npmjs.com/package/workflow"><img alt="npm version" src="https://img.shields.io/npm/v/workflow?style=for-the-badge&labelColor=000000"></a>
 <a href="https://github.com/vercel/workflow/blob/main/LICENSE.md"><img alt="License" src="https://img.shields.io/npm/l/workflow.svg?style=for-the-badge&labelColor=000000"></a>
-<a href="https://github.com/vercel/workflow/discussions"><img alt="Join the community on GitHub" src="https://img.shields.io/badge/Join%20the%20community-blueviolet.svg?style=for-the-badge&logo=Github&labelColor=000000&logoWidth=20"></a>
+<a href="https://github.com/vercel/workflow/discussions"><img alt="Join the community on GitHub" src="https://img.shields.io/badge/Join%20the%20community-blueviolet.svg?style=for-the-badge&logo=GitHub&labelColor=000000&logoWidth=20"></a>
 
 </div>
 
@@ -70,7 +70,9 @@ Vercel for managed storage, queuing, scaling, and observability. To self-host,
 use the Postgres backend or implement a custom
 [World](https://workflow-sdk.dev/docs/deploying).
 
-There are many third-party Worlds (both self-hosted or managed), see [the Worlds page](https://workflow-sdk.dev/worlds) for a list of maintainer-curated third party worlds. Submit your world by opening updating the [Worlds Manifest](https://github.com/vercel/workflow/blob/main/worlds-manifest.json).
+The [Worlds page](https://workflow-sdk.dev/worlds) lists maintainer-curated
+third-party Worlds, including self-hosted and managed options. Submit your World
+by updating the [Worlds Manifest](https://github.com/vercel/workflow/blob/main/worlds-manifest.json).
 
 ## Community
 
@@ -88,7 +90,7 @@ with the team and wider community. By participating, you agree to our
 
 ## Security
 
-If you believe you have found a security vulnerability in Workflow SDK, we encourage you to **_responsibly disclose this and not open a public issue_**.
+If you find a security vulnerability in Workflow SDK, **_disclose it responsibly instead of opening a public issue_**.
 
 To participate in our Open Source Software Bug Bounty program, please email
 [responsible.disclosure@vercel.com](mailto:responsible.disclosure@vercel.com).

package/dist/internal/builtins.d.ts

@@ -1,7 +1,7 @@
 /**
- * These are the built-in steps that are "automatically available" in the workflow scope. They are
- * similar to "stdlib" except that are not meant to be imported by users, but are instead "just available"
- * alongside user defined steps. They are used internally by the runtime
+ * Built-in steps available in the workflow scope. Like a standard library,
+ * they are available alongside user-defined steps, but users do not import
+ * them. The runtime uses these steps internally.
  */
 export declare function __builtin_response_array_buffer(this: Request | Response): Promise<ArrayBuffer>;
 export declare function __builtin_response_json(this: Request | Response): Promise<unknown>;
@@ -12,7 +12,7 @@ export declare function __builtin_response_text(this: Request | Response): Promi
  * runs in normal Node context with full world access.
  *
  * The dispatch reads the world and current run id directly from
- * `globalThis` symbols populated by the workflow/step runtime — this
+ * `globalThis` symbols populated by the workflow/step runtime. This
  * intentionally avoids importing `@workflow/core` so the Next.js
  * deferred-entries discoverer can't walk a chain into world adapters
  * and `@vercel/queue` from this step file.

package/dist/internal/builtins.js

@@ -1,7 +1,7 @@
 /**
- * These are the built-in steps that are "automatically available" in the workflow scope. They are
- * similar to "stdlib" except that are not meant to be imported by users, but are instead "just available"
- * alongside user defined steps. They are used internally by the runtime
+ * Built-in steps available in the workflow scope. Like a standard library,
+ * they are available alongside user-defined steps, but users do not import
+ * them. The runtime uses these steps internally.
  */
 export async function __builtin_response_array_buffer() {
     'use step';
@@ -33,7 +33,7 @@ function formatUnknownError(error) {
  * runs in normal Node context with full world access.
  *
  * The dispatch reads the world and current run id directly from
- * `globalThis` symbols populated by the workflow/step runtime — this
+ * `globalThis` symbols populated by the workflow/step runtime. This
  * intentionally avoids importing `@workflow/core` so the Next.js
  * deferred-entries discoverer can't walk a chain into world adapters
  * and `@vercel/queue` from this step file.
@@ -50,7 +50,7 @@ export async function __builtin_set_attributes(changes, options) {
         : INTERNAL_ATTRIBUTES_MAX_ATTEMPTS;
     const world = g[Symbol.for('@workflow/world//cache')];
     if (typeof world?.runs?.experimentalSetAttributes !== 'function') {
-        // World adapter doesn't implement attributes yet — no-op the call,
+        // World adapter doesn't implement attributes yet, so no-op the call,
         // but emit one process-wide warning so users know their writes are
         // being dropped. The VM-side validation already ran so the input
         // is well-formed.
@@ -79,4 +79,4 @@ export async function __builtin_set_attributes(changes, options) {
     }
 }
 __builtin_set_attributes.maxRetries = INTERNAL_ATTRIBUTES_MAX_ATTEMPTS - 1;
-//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"builtins.js","sourceRoot":"","sources":["../../src/internal/builtins.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,MAAM,CAAC,KAAK,UAAU,+BAA+B;IAGnD,UAAU,CAAC;IACX,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC;AAC5B,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,uBAAuB;IAC3C,UAAU,CAAC;IACX,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;AACrB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,uBAAuB;IAC3C,UAAU,CAAC;IACX,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;AACrB,CAAC;AAED;;;GAGG;AACH,MAAM,wBAAwB,GAAG,MAAM,CAAC,GAAG,CACzC,iDAAiD,CAClD,CAAC;AAEF,MAAM,gCAAgC,GAAG,CAAC,CAAC;AAE3C,SAAS,kBAAkB,CAAC,KAAc;IACxC,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;QAC3B,OAAO,KAAK,CAAC,KAAK,IAAI,GAAG,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC;IAC1D,CAAC;IACD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;AACvB,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAC5C,OAAqD,EACrD,OAA+C;IAE/C,UAAU,CAAC;IACX,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO;IACjC,MAAM,CAAC,GAAG,UAAqC,CAAC;IAEhD,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,+BAA+B,CAAC,CASvD,CAAC;IACd,MAAM,KAAK,GAAG,cAAc,EAAE,QAAQ,EAAE,EAAE,CAAC;IAC3C,MAAM,OAAO,GACX,OAAO,KAAK,EAAE,YAAY,EAAE,OAAO,KAAK,QAAQ;QAC9C,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,OAAO;QAC5B,CAAC,CAAC,gCAAgC,CAAC;IAEvC,MAAM,KAAK,GAAG,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAWvC,CAAC;IACd,IAAI,OAAO,KAAK,EAAE,IAAI,EAAE,yBAAyB,KAAK,UAAU,EAAE,CAAC;QACjE,mEAAmE;QACnE,mEAAmE;QACnE,iEAAiE;QACjE,kBAAkB;QAClB,IAAI,CAAC,CAAC,CAAC,wBAAwB,CAAC,EAAE,CAAC;YACjC,CAAC,CAAC,wBAAwB,CAAC,GAAG,IAAI,CAAC;YACnC,MAAM,SAAS,GAAG,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;YACxD,OAAO,CAAC,IAAI,CACV,6DAA6D,SAAS,qMAAqM,CAC5Q,CAAC;QACJ,CAAC;QACD,OAAO;IACT,CAAC;IAED,IAAI,CAAC;QACH,MAAM,KAAK,GAAG,KAAK,EAAE,gBAAgB,EAAE,aAAa,CAAC;QACrD,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CACb,wEAAwE,CACzE,CAAC;QACJ,CAAC;QAED,MAAM,KAAK,CAAC,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,OAAO,GAAG,gCAAgC,EAAE,CAAC;YAC/C,MAAM,KAAK,CAAC;QACd,CAAC;QAED,4EAA4E;QAC5E,sEAAsE;QACtE,+DAA+D;QAC/D,OAAO,CAAC,KAAK,CACX,uDAAuD,gCAAgC,qDAAqD,kBAAkB,CAAC,KAAK,CAAC,EAAE,CACxK,CAAC;IACJ,CAAC;AACH,CAAC;AAGC,wBAGD,CAAC,UAAU,GAAG,gCAAgC,GAAG,CAAC,CAAC","sourcesContent":["/**\n * These are the built-in steps that are \"automatically available\" in the workflow scope. They are\n * similar to \"stdlib\" except that are not meant to be imported by users, but are instead \"just available\"\n * alongside user defined steps. They are used internally by the runtime\n */\n\nexport async function __builtin_response_array_buffer(\n  this: Request | Response\n) {\n  'use step';\n  return this.arrayBuffer();\n}\n\nexport async function __builtin_response_json(this: Request | Response) {\n  'use step';\n  return this.json();\n}\n\nexport async function __builtin_response_text(this: Request | Response) {\n  'use step';\n  return this.text();\n}\n\n/**\n * Process-wide dedupe for the unsupported-world warning so high-volume\n * callers don't flood logs.\n */\nconst UNSUPPORTED_WORLD_WARNED = Symbol.for(\n  '@workflow/setAttributes//unsupportedWorldWarned'\n);\n\nconst INTERNAL_ATTRIBUTES_MAX_ATTEMPTS = 3;\n\nfunction formatUnknownError(error: unknown) {\n  if (error instanceof Error) {\n    return error.stack ?? `${error.name}: ${error.message}`;\n  }\n  return String(error);\n}\n\n/**\n * Step bridge for workflow-body `setAttributes` calls. The VM-side\n * helper validates input and dispatches here via `useStep`. This step\n * runs in normal Node context with full world access.\n *\n * The dispatch reads the world and current run id directly from\n * `globalThis` symbols populated by the workflow/step runtime — this\n * intentionally avoids importing `@workflow/core` so the Next.js\n * deferred-entries discoverer can't walk a chain into world adapters\n * and `@vercel/queue` from this step file.\n */\nexport async function __builtin_set_attributes(\n  changes: Array<{ key: string; value: string | null }>,\n  options?: { allowReservedAttributes?: boolean }\n) {\n  'use step';\n  if (changes.length === 0) return;\n  const g = globalThis as Record<symbol, unknown>;\n\n  const contextStorage = g[Symbol.for('WORKFLOW_STEP_CONTEXT_STORAGE')] as\n    | {\n        getStore: () =>\n          | {\n              stepMetadata?: { attempt?: number };\n              workflowMetadata?: { workflowRunId?: string };\n            }\n          | undefined;\n      }\n    | undefined;\n  const store = contextStorage?.getStore?.();\n  const attempt =\n    typeof store?.stepMetadata?.attempt === 'number'\n      ? store.stepMetadata.attempt\n      : INTERNAL_ATTRIBUTES_MAX_ATTEMPTS;\n\n  const world = g[Symbol.for('@workflow/world//cache')] as\n    | {\n        name?: string;\n        runs?: {\n          experimentalSetAttributes?: (\n            runId: string,\n            changes: Array<{ key: string; value: string | null }>,\n            options?: { allowReservedAttributes?: boolean }\n          ) => Promise<unknown>;\n        };\n      }\n    | undefined;\n  if (typeof world?.runs?.experimentalSetAttributes !== 'function') {\n    // World adapter doesn't implement attributes yet — no-op the call,\n    // but emit one process-wide warning so users know their writes are\n    // being dropped. The VM-side validation already ran so the input\n    // is well-formed.\n    if (!g[UNSUPPORTED_WORLD_WARNED]) {\n      g[UNSUPPORTED_WORLD_WARNED] = true;\n      const worldName = world?.name ? ` (${world.name})` : '';\n      console.warn(\n        `[workflow] setAttributes: the current world implementation${worldName} does not implement experimentalSetAttributes; this call (and any subsequent setAttributes calls in this process) is a no-op. Attributes will become available once the world adapter adds support.`\n      );\n    }\n    return;\n  }\n\n  try {\n    const runId = store?.workflowMetadata?.workflowRunId;\n    if (!runId) {\n      throw new Error(\n        '__builtin_set_attributes: no workflow run id available in step context'\n      );\n    }\n\n    await world.runs.experimentalSetAttributes(runId, changes, options);\n  } catch (error) {\n    if (attempt < INTERNAL_ATTRIBUTES_MAX_ATTEMPTS) {\n      throw error;\n    }\n\n    // Failing to post tags should not fail a run during the experimental phase.\n    // After three attempts, log and let the internal step complete so the\n    // runtime does not convert retry exhaustion into a FatalError.\n    console.error(\n      `[workflow] setAttributes: failed to post tags after ${INTERNAL_ATTRIBUTES_MAX_ATTEMPTS} attempts; dropping the internal attribute write. ${formatUnknownError(error)}`\n    );\n  }\n}\n\n(\n  __builtin_set_attributes as typeof __builtin_set_attributes & {\n    maxRetries: number;\n  }\n).maxRetries = INTERNAL_ATTRIBUTES_MAX_ATTEMPTS - 1;\n"]}
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"builtins.js","sourceRoot":"","sources":["../../src/internal/builtins.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AAEH,MAAM,CAAC,KAAK,UAAU,+BAA+B;IAGnD,UAAU,CAAC;IACX,OAAO,IAAI,CAAC,WAAW,EAAE,CAAC;AAC5B,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,uBAAuB;IAC3C,UAAU,CAAC;IACX,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;AACrB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,uBAAuB;IAC3C,UAAU,CAAC;IACX,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;AACrB,CAAC;AAED;;;GAGG;AACH,MAAM,wBAAwB,GAAG,MAAM,CAAC,GAAG,CACzC,iDAAiD,CAClD,CAAC;AAEF,MAAM,gCAAgC,GAAG,CAAC,CAAC;AAE3C,SAAS,kBAAkB,CAAC,KAAc;IACxC,IAAI,KAAK,YAAY,KAAK,EAAE,CAAC;QAC3B,OAAO,KAAK,CAAC,KAAK,IAAI,GAAG,KAAK,CAAC,IAAI,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC;IAC1D,CAAC;IACD,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;AACvB,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAC5C,OAAqD,EACrD,OAA+C;IAE/C,UAAU,CAAC;IACX,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO;IACjC,MAAM,CAAC,GAAG,UAAqC,CAAC;IAEhD,MAAM,cAAc,GAAG,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,+BAA+B,CAAC,CASvD,CAAC;IACd,MAAM,KAAK,GAAG,cAAc,EAAE,QAAQ,EAAE,EAAE,CAAC;IAC3C,MAAM,OAAO,GACX,OAAO,KAAK,EAAE,YAAY,EAAE,OAAO,KAAK,QAAQ;QAC9C,CAAC,CAAC,KAAK,CAAC,YAAY,CAAC,OAAO;QAC5B,CAAC,CAAC,gCAAgC,CAAC;IAEvC,MAAM,KAAK,GAAG,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,wBAAwB,CAAC,CAWvC,CAAC;IACd,IAAI,OAAO,KAAK,EAAE,IAAI,EAAE,yBAAyB,KAAK,UAAU,EAAE,CAAC;QACjE,qEAAqE;QACrE,mEAAmE;QACnE,iEAAiE;QACjE,kBAAkB;QAClB,IAAI,CAAC,CAAC,CAAC,wBAAwB,CAAC,EAAE,CAAC;YACjC,CAAC,CAAC,wBAAwB,CAAC,GAAG,IAAI,CAAC;YACnC,MAAM,SAAS,GAAG,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;YACxD,OAAO,CAAC,IAAI,CACV,6DAA6D,SAAS,qMAAqM,CAC5Q,CAAC;QACJ,CAAC;QACD,OAAO;IACT,CAAC;IAED,IAAI,CAAC;QACH,MAAM,KAAK,GAAG,KAAK,EAAE,gBAAgB,EAAE,aAAa,CAAC;QACrD,IAAI,CAAC,KAAK,EAAE,CAAC;YACX,MAAM,IAAI,KAAK,CACb,wEAAwE,CACzE,CAAC;QACJ,CAAC;QAED,MAAM,KAAK,CAAC,IAAI,CAAC,yBAAyB,CAAC,KAAK,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;IACtE,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,OAAO,GAAG,gCAAgC,EAAE,CAAC;YAC/C,MAAM,KAAK,CAAC;QACd,CAAC;QAED,4EAA4E;QAC5E,sEAAsE;QACtE,+DAA+D;QAC/D,OAAO,CAAC,KAAK,CACX,uDAAuD,gCAAgC,qDAAqD,kBAAkB,CAAC,KAAK,CAAC,EAAE,CACxK,CAAC;IACJ,CAAC;AACH,CAAC;AAGC,wBAGD,CAAC,UAAU,GAAG,gCAAgC,GAAG,CAAC,CAAC","sourcesContent":["/**\n * Built-in steps available in the workflow scope. Like a standard library,\n * they are available alongside user-defined steps, but users do not import\n * them. The runtime uses these steps internally.\n */\n\nexport async function __builtin_response_array_buffer(\n  this: Request | Response\n) {\n  'use step';\n  return this.arrayBuffer();\n}\n\nexport async function __builtin_response_json(this: Request | Response) {\n  'use step';\n  return this.json();\n}\n\nexport async function __builtin_response_text(this: Request | Response) {\n  'use step';\n  return this.text();\n}\n\n/**\n * Process-wide dedupe for the unsupported-world warning so high-volume\n * callers don't flood logs.\n */\nconst UNSUPPORTED_WORLD_WARNED = Symbol.for(\n  '@workflow/setAttributes//unsupportedWorldWarned'\n);\n\nconst INTERNAL_ATTRIBUTES_MAX_ATTEMPTS = 3;\n\nfunction formatUnknownError(error: unknown) {\n  if (error instanceof Error) {\n    return error.stack ?? `${error.name}: ${error.message}`;\n  }\n  return String(error);\n}\n\n/**\n * Step bridge for workflow-body `setAttributes` calls. The VM-side\n * helper validates input and dispatches here via `useStep`. This step\n * runs in normal Node context with full world access.\n *\n * The dispatch reads the world and current run id directly from\n * `globalThis` symbols populated by the workflow/step runtime. This\n * intentionally avoids importing `@workflow/core` so the Next.js\n * deferred-entries discoverer can't walk a chain into world adapters\n * and `@vercel/queue` from this step file.\n */\nexport async function __builtin_set_attributes(\n  changes: Array<{ key: string; value: string | null }>,\n  options?: { allowReservedAttributes?: boolean }\n) {\n  'use step';\n  if (changes.length === 0) return;\n  const g = globalThis as Record<symbol, unknown>;\n\n  const contextStorage = g[Symbol.for('WORKFLOW_STEP_CONTEXT_STORAGE')] as\n    | {\n        getStore: () =>\n          | {\n              stepMetadata?: { attempt?: number };\n              workflowMetadata?: { workflowRunId?: string };\n            }\n          | undefined;\n      }\n    | undefined;\n  const store = contextStorage?.getStore?.();\n  const attempt =\n    typeof store?.stepMetadata?.attempt === 'number'\n      ? store.stepMetadata.attempt\n      : INTERNAL_ATTRIBUTES_MAX_ATTEMPTS;\n\n  const world = g[Symbol.for('@workflow/world//cache')] as\n    | {\n        name?: string;\n        runs?: {\n          experimentalSetAttributes?: (\n            runId: string,\n            changes: Array<{ key: string; value: string | null }>,\n            options?: { allowReservedAttributes?: boolean }\n          ) => Promise<unknown>;\n        };\n      }\n    | undefined;\n  if (typeof world?.runs?.experimentalSetAttributes !== 'function') {\n    // World adapter doesn't implement attributes yet, so no-op the call,\n    // but emit one process-wide warning so users know their writes are\n    // being dropped. The VM-side validation already ran so the input\n    // is well-formed.\n    if (!g[UNSUPPORTED_WORLD_WARNED]) {\n      g[UNSUPPORTED_WORLD_WARNED] = true;\n      const worldName = world?.name ? ` (${world.name})` : '';\n      console.warn(\n        `[workflow] setAttributes: the current world implementation${worldName} does not implement experimentalSetAttributes; this call (and any subsequent setAttributes calls in this process) is a no-op. Attributes will become available once the world adapter adds support.`\n      );\n    }\n    return;\n  }\n\n  try {\n    const runId = store?.workflowMetadata?.workflowRunId;\n    if (!runId) {\n      throw new Error(\n        '__builtin_set_attributes: no workflow run id available in step context'\n      );\n    }\n\n    await world.runs.experimentalSetAttributes(runId, changes, options);\n  } catch (error) {\n    if (attempt < INTERNAL_ATTRIBUTES_MAX_ATTEMPTS) {\n      throw error;\n    }\n\n    // Failing to post tags should not fail a run during the experimental phase.\n    // After three attempts, log and let the internal step complete so the\n    // runtime does not convert retry exhaustion into a FatalError.\n    console.error(\n      `[workflow] setAttributes: failed to post tags after ${INTERNAL_ATTRIBUTES_MAX_ATTEMPTS} attempts; dropping the internal attribute write. ${formatUnknownError(error)}`\n    );\n  }\n}\n\n(\n  __builtin_set_attributes as typeof __builtin_set_attributes & {\n    maxRetries: number;\n  }\n).maxRetries = INTERNAL_ATTRIBUTES_MAX_ATTEMPTS - 1;\n"]}

package/docs/ai/chat-session-modeling.mdx

@@ -22,7 +22,7 @@ Chat sessions in AI agents can be modeled at different layers of your architectu
 
 While there are many ways to model chat sessions, the two most common categories are single-turn and multi-turn.
 
-## Single-Turn Workflows
+## Single-turn workflows
 
 Each user message triggers a new workflow run. The client or API route owns the conversation history and sends the full message array with each request.
 
@@ -81,7 +81,7 @@ export async function POST(req: Request) {
 
 <Tab value="Client">
 
-Chat messages need to be stored somewhere—typically a database. In this example, we assume a route like `/chats/:id` passes the session ID, allowing us to fetch existing messages and persist new ones.
+Chat messages need to be stored somewhere, typically a database. In this example, we assume a route like `/chats/:id` passes the session ID, allowing us to fetch existing messages and persist new ones.
 
 ```typescript title="app/chats/[id]/page.tsx" lineNumbers
 "use client";
@@ -138,14 +138,13 @@ This is the pattern used in the [Building Durable AI Agents](/docs/ai) guide.
 
 In this pattern, the client owns conversation state, with the latest turn managed by the AI SDK's `useChat`, and past turns persisted to a user-managed database.
 
-Persisting the turn is usually done through either:
+Persist the turn through one of these methods:
 
-- A step on the workflow that runs after `agent.stream()` and takes the message history from the agent return value (either `messages: ModelMessage[]` or `uiMessages: UIMessage[]`)
-- A hook on `useChat`in the client that calls an API to persist state (or localStorage, etc.), either on every new message, or `onFinish`
-- The resumable stream attached to the workflow (see [Resumable Streams](/docs/ai/resumable-streams))
-  - Note that user messages are not persisted to the stream by default, and need to be explicitly persisted separately
+- Run a workflow step after `agent.stream()` that takes the message history from the agent return value (either `messages: ModelMessage[]` or `uiMessages: UIMessage[]`).
+- Use a `useChat` client hook that calls an API to persist state, such as on every new message or in `onFinish`.
+- Use the resumable stream attached to the workflow (see [Resumable streams](/docs/ai/resumable-streams)). User messages are not persisted to the stream by default, so persist them separately.
 
-## Multi-Turn Workflows
+## Multi-turn workflows
 
 A single workflow handles the entire conversation session across multiple turns, and owns the current conversation state. The clients/API routes inject new messages via hooks. The workflow run ID serves as the session identifier.
 
@@ -191,7 +190,7 @@ export async function chat(initialMessages: UIMessage[]) {
     tools: flightBookingTools,
   });
 
-  // Use run ID as the hook token for easy resumption
+  // Use run ID as the hook token for resumption
   const hook = chatMessageHook.create({ token: runId });
   let turnNumber = 0;
 
@@ -254,7 +253,7 @@ export async function writeStreamClose(writable: WritableStream<UIMessageChunk>)
 
 <Tab value="API Routes">
 
-Three endpoints: start a session, send follow-up messages, and reconnect to the stream.
+Use three endpoints to start a session, send follow-up messages, and reconnect to the stream.
 
 ```typescript title="app/api/chat/route.ts" lineNumbers
 import { createUIMessageStreamResponse, type UIMessage } from "ai";
@@ -493,13 +492,13 @@ In this pattern, the workflow owns the entire conversation session. All messages
 
 The client hook processes these markers by:
 
-1. Iterating through message parts in order
-2. When a `user-message` marker is found, flushing any accumulated assistant content and inserting the user message
-3. Deduplicating against optimistic sends from the initial message
+1. Iterate through message parts in order.
+2. When a `user-message` marker is found, flush any accumulated assistant content and insert the user message.
+3. Deduplicate against optimistic sends from the initial message.
 
 This ensures the conversation displays as User → AI → User → AI regardless of whether viewing live or replaying from the stream.
 
-## Choosing a Pattern
+## Choosing a pattern
 
 | Consideration | Single-Turn | Multi-Turn |
 |--------------|-------------|------------|
@@ -509,13 +508,13 @@ This ensures the conversation displays as User → AI → User → AI regardless
 | Workflow time horizon | Minutes | Hours to indefinitely |
 | Observability scope | Per-turn traces | Full session traces |
 
-**Multi-turn is recommended for most production use-cases.** If you're starting fresh, go with multi-turn. It's more flexible and grows with your requirements. You don't need to maintain the chat history yourself and can offload all that to the workflow's built in persistence. It also enables native message injection and full session observability, which becomes increasingly valuable as your agent matures.
+**Multi-turn is recommended for most production use cases.** For new applications, use multi-turn workflows. The workflow's built-in persistence maintains the chat history and supports native message injection and full-session observability.
 
-**Single-turn works well when adapting existing architectures.** If you already have a system for managing message state, and want to adopt durable agents incrementally, single-turn workflows slot in with minimal changes. Each turn maps cleanly to an independent workflow run.
+**Single-turn works well when adapting existing architectures.** If you already have a system for managing message state and want to adopt durable agents incrementally, single-turn workflows require fewer changes. Each turn maps to an independent workflow run.
 
-## Multiplayer Chat Sessions
+## Multiplayer chat sessions
 
-The multi-turn pattern also easily enables multi-player chat sessions. New messages can come from system events, external services, and other users. Since a `hook` injects messages into workflow at any point, and the entire history is a single stream that clients can reconnect to, it doesn't matter where the injected messages come from. Here are different use-cases for multi-player chat sessions:
+The multi-turn pattern also enables multiplayer chat sessions. Messages can come from system events, external services, and other users. A `hook` can inject messages into a workflow at any point, while clients reconnect to one stream containing the entire history.
 
 <Tabs items={['System Event', 'External Service', 'Multiple Users']}>
 
@@ -542,7 +541,7 @@ export async function POST(req: Request) {
 
 <Tab value="External Service">
 
-External webhooks from third-party services (Stripe, Twilio, etc.) can notify the conversation of events.
+External webhooks from third-party services, such as Stripe and Twilio, can notify the conversation of events.
 
 ```typescript title="app/api/webhooks/payment/route.ts" lineNumbers
 import { chatMessageHook } from "@/workflows/chat/hooks/chat-message";
@@ -591,9 +590,9 @@ export async function POST(
 
 </Tabs>
 
-## Related Documentation
+## Related documentation
 
-- [Building Durable AI Agents](/docs/ai) - Foundation guide for durable agents
-- [Message Queueing](/docs/ai/message-queueing) - Queueing messages during tool execution
-- [`defineHook()` API Reference](/docs/api-reference/workflow/define-hook) - Hook configuration options
-- [`WorkflowAgent`](https://ai-sdk.dev/v7/docs/agents/workflow-agent#workflowagent) - AI SDK API for durable, resumable agents
+- [Building Durable AI Agents](/docs/ai): Foundation guide for durable agents
+- [Message Queueing](/docs/ai/message-queueing): Queueing messages during tool execution
+- [`defineHook()` API reference](/docs/api-reference/workflow/define-hook): Hook configuration options
+- [`WorkflowAgent`](https://ai-sdk.dev/v7/docs/agents/workflow-agent#workflowagent): AI SDK API for durable, resumable agents

package/docs/ai/defining-tools.mdx

@@ -14,16 +14,15 @@ related:
 
 This page covers the details for some common patterns when defining tools for AI agents using Workflow SDK.
 
-Using WorkflowAgent, we model most tools as steps. These can be anything from a simple function call to a entire multi-day long workflow.
+Using WorkflowAgent, we model most tools as steps. These can range from a single function call to an entire multi-day workflow.
 
 ## Accessing message context in tools
 
-Just like in regular AI SDK tool definitions, tool in WorkflowAgent are called with a first argument of the tool's input parameters, and a second argument of the tool call context.
+As with regular AI SDK tool definitions, tools in WorkflowAgent receive the tool's input parameters as the first argument and the tool call context as the second.
 
 When you tool needs access to the full message history, you can access it via the `messages` property of the tool call context:
 
 ```typescript title="tools.ts" lineNumbers
-import { Experimental_Agent as Agent } from "ai";
 import type { ModelMessage } from "ai";
 
 async function getWeather(
@@ -34,9 +33,9 @@ async function getWeather(
 }
 ```
 
-## Writing to Streams
+## Writing to streams
 
-As discussed in [Streaming Updates from Tools](/docs/ai/streaming-updates-from-tools), it's common to use a step just to call `getWritable()` for writing custom data parts to the stream.
+As discussed in [Streaming Updates from Tools](/docs/ai/streaming-updates-from-tools), it's common to use a step only to call `getWritable()` for writing custom data parts to the stream.
 
 This can be made generic, by creating a helper step function to write arbitrary data to the stream:
 
@@ -53,7 +52,7 @@ async function writeToStream(data: any) {
 }
 ```
 
-## Step-Level vs Workflow-Level Tools
+## Step-level vs workflow-level tools
 
 Tools can be implemented either at the step level or the workflow level, with different capabilities and constraints.
 

package/docs/ai/human-in-the-loop.mdx

@@ -19,7 +19,7 @@ Workflow SDK's [webhook](/docs/api-reference/workflow/create-webhook) and [hook]
 
 If you need to react to external events programmatically, see the [hooks](/docs/foundations/hooks) documentation for more information. This part of the guide will focus on the human-in-the-loop pattern, which is a subset of the more general hook pattern.
 
-## How It Works
+## How it works
 
 <Steps>
 
@@ -45,9 +45,9 @@ The workflow receives the approval data and resumes execution.
 
 </Steps>
 
-While this demo will use a client side button for human approval, you could just as easily create a webhook and send the approval link over email or slack to resume the agent.
+While this demo uses a client-side button for human approval, you could instead create a webhook and send the approval link over email or Slack to resume the agent.
 
-## Creating a Booking Approval Tool
+## Creating a booking approval tool
 
 Add a tool that allows the agent to deliberately pause execution until a human approves or rejects a flight booking:
 
@@ -55,7 +55,7 @@ Add a tool that allows the agent to deliberately pause execution until a human a
 
 <Step>
 
-### Define the Hook
+### Define the hook
 
 Create a typed hook with a Zod schema for validation:
 
@@ -78,7 +78,7 @@ export const bookingApprovalHook = defineHook({
 
 <Step>
 
-### Implement the Tool
+### Implement the tool
 
 Create a tool that creates a hook instance using the tool call ID as the token. The UI will use this ID to submit the approval.
 
@@ -126,14 +126,14 @@ export const flightBookingTools = {
 ```
 
 <Callout type="info">
-Note that the `defineHook().create()` function must be called from within a workflow context, not from within a step. This is why `executeBookingApproval` does not have `"use step"` - it runs in the workflow context where hooks are available.
+Call `defineHook().create()` from within a workflow context, not from within a step. `executeBookingApproval` does not have `"use step"` because it runs in the workflow context where hooks are available.
 </Callout>
 
 </Step>
 
 <Step>
 
-### Create the API Route
+### Create the API route
 
 Create a new API endpoint that the UI will call to submit the approval decision:
 
@@ -158,7 +158,7 @@ export async function POST(request: Request) {
 
 <Step>
 
-### Create the Approval Component
+### Create the approval component
 
 Build a new component that reacts to the tool call data, and allows the user to approve or reject the booking:
 
@@ -253,7 +253,7 @@ export function BookingApproval({ toolCallId, input, output }: BookingApprovalPr
 
 <Step>
 
-### Show the Tool Status in the UI
+### Show the tool status in the UI
 
 Use the component we just created to render the tool call and approval controls in your chat interface:
 
@@ -332,7 +332,7 @@ export default function ChatPage() {
 
 </Steps>
 
-## Using Webhooks Directly
+## Using webhooks directly
 
 For simpler cases where you don't need type-safe validation or programmatic resumption, you can use [`createWebhook()`](/docs/api-reference/workflow/create-webhook) directly. This generates a unique URL that can be called to resume the workflow:
 
@@ -367,7 +367,7 @@ The webhook URL can be called directly with a POST request containing the approv
 - Payment provider callbacks
 - Email-based approval links
 
-## Related Documentation
+## Related documentation
 
 - [Hooks & Webhooks](/docs/foundations/hooks) - Complete guide to hooks and webhooks
 - [`createWebhook()` API Reference](/docs/api-reference/workflow/create-webhook) - Webhook configuration options

package/docs/ai/index.mdx

@@ -22,7 +22,7 @@ Workflow SDK makes your agents production-ready, by turning them into durable, r
 
 This guide walks you through converting a basic AI chat app into a durable AI agent using Workflow SDK.
 
-## Why Durable Agents?
+## Why durable agents?
 
 Aside from the usual challenges of getting your long-running tasks to be production-ready, building mature AI agents typically requires solving several **additional challenges**:
 
@@ -31,22 +31,22 @@ Aside from the usual challenges of getting your long-running tasks to be product
 - **Resumability**: Resuming streams requires not just storing your messages, but also storing streams, and piping them across services.
 - **Human-in-the-loop**: Your client, API, and async job orchestration need to work together to create, track, route to, and display human approval requests, or similar webhook operations.
 
-Workflow SDK provides all of these capabilities out of the box. Your agent becomes a workflow, your tools become steps, and the framework handles interplay with your existing infrastructure.
+Workflow SDK provides all of these capabilities without additional infrastructure. Your agent becomes a workflow, your tools become steps, and the framework handles interplay with your existing infrastructure.
 
-## Getting Started
+## Getting started
 
 To make an Agent durable, we first need an Agent, which we'll be setting up here. If you already have an app you'd like to follow along with, you can skip this section.
 
-For our example, we'll need an app with a simple chat interface and an API route calling an LLM, so that we can add Workflow SDK to it. We'll use the [Flight Booking Agent](https://github.com/vercel/workflow-examples/tree/main/flight-booking-app) example as a starting point, which comes with a chat interface built using Next.js, AI SDK, and Shadcn UI.
+For our example, we'll need an app with a basic chat interface and an API route calling an LLM, so that we can add Workflow SDK to it. We'll use the [Flight Booking Agent](https://github.com/vercel/workflow-examples/tree/main/flight-booking-app) example as a starting point, which comes with a chat interface built using Next.js, AI SDK, and Shadcn UI.
 
 <Steps>
 
 <Step>
 ### Clone example app
 
-We'll need an app with a simple chat interface and an API route calling an LLM, so that we can add Workflow SDK to it. For the follow-along steps, we'll use the [Flight Booking Agent](https://github.com/vercel/workflow-examples/tree/main/flight-booking-app) example as a starting point, which comes with a chat interface built using Next.js, AI SDK, and Shadcn UI.
+We'll need an app with a basic chat interface and an API route calling an LLM, so that we can add Workflow SDK to it. For the follow-along steps, we'll use the [Flight Booking Agent](https://github.com/vercel/workflow-examples/tree/main/flight-booking-app) example as a starting point, which comes with a chat interface built using Next.js, AI SDK, and Shadcn UI.
 
-If you have your own project, you can skip this step, and simply apply the changes of the following steps to your own project.
+If you have your own project, skip this step and apply the changes in the following steps to your project.
 
 ```bash
 git clone https://github.com/vercel/workflow-examples -b plain-ai-sdk
@@ -59,7 +59,7 @@ cd workflow-examples/flight-booking-app
 
 ### Set up API keys
 
-In order to connect to an LLM, we'll need to set up an API key. The easiest way to do this is to use Vercel Gateway (works with all providers at zero markup), or you can configure a custom provider.
+To connect to an LLM, set up an API key. You can use Vercel Gateway, which works with all providers at zero markup, or configure a custom provider.
 <Tabs items={['Gateway', 'Custom Provider']}>
 
 <Tab value="Gateway">
@@ -113,15 +113,15 @@ export async function POST(req: Request) {
 
 ### Get familiar with the code
 
-Let's take a moment to see what we're working with. Run the app with `npm run dev` and open [http://localhost:3000](http://localhost:3000) in your browser. You should see a simple chat interface to play with. Go ahead and give it a try.
+Run the app with `npm run dev` and open [http://localhost:3000](http://localhost:3000) in your browser. You should see a basic chat interface to test.
 
-The core code that makes all of this happen is quite simple. Here's a breakdown of the main parts. Note that there's no changes needed here, we're simply taking a look at the code to understand what's happening.
+The following sections break down the core code. You don't need to make changes yet.
 
 <Tabs items={['API Route', 'Tools', 'Client']}>
 
 <Tab value="API Route">
 
-Our API route makes a simple call to [AI SDK's `ToolLoopAgent` class](https://ai-sdk.dev/docs/agents/overview), which encapsulates the LLM call, tool execution loop, and stopping conditions on top of [AI SDK's `streamText` function](https://ai-sdk.dev/docs/reference/ai-sdk-core/stream-text#streamtext). This is also where we pass tools to the agent.
+Our API route calls [AI SDK's `ToolLoopAgent` class](https://ai-sdk.dev/docs/agents/overview), which encapsulates the LLM call, tool execution loop, and stopping conditions on top of [AI SDK's `streamText` function](https://ai-sdk.dev/docs/reference/ai-sdk-core/stream-text#streamtext). This is also where we pass tools to the agent.
 
 ```typescript title="app/api/chat/route.ts" lineNumbers
 import { ToolLoopAgent } from "ai";
@@ -170,7 +170,7 @@ async function searchFlights({ from, to, date }: { from: string; to: string; dat
 
 <Tab value="Client">
 
-Our `ChatPage` component has a lot of logic for nicely displaying the chat messages, but at it's core, it's simply managing input/output for the [`useChat` hook](https://ai-sdk.dev/docs/reference/ai-sdk-ui/use-chat#usechat) from AI SDK.
+Our `ChatPage` component contains logic for displaying chat messages, but its core responsibility is managing input and output for the [`useChat` hook](https://ai-sdk.dev/docs/reference/ai-sdk-ui/use-chat#usechat) from AI SDK.
 
 ```typescript title="app/chat.tsx" lineNumbers
 "use client";
@@ -228,7 +228,7 @@ Now that we have a basic agent using AI SDK, we can modify it to make it durable
 <Steps>
 <Step>
 
-### Install Dependencies
+### Install dependencies
 
 Add the Workflow SDK packages to your project:
 
@@ -253,7 +253,7 @@ export default withWorkflow(nextConfig);
 
 <Step>
 
-### Create a Workflow Function
+### Create a workflow function
 
 Move the agent logic into a separate function, which will serve as our workflow definition.
 
@@ -272,7 +272,7 @@ export async function chatWorkflow(messages: UIMessage[]) {
 
   const agent = new WorkflowAgent({ // [!code highlight]
 
-    // If using AI Gateway, just specify the model name as a string:
+    // If using AI Gateway, specify the model name as a string:
     model: "bedrock/claude-4-5-haiku-20251001-v1", // [!code highlight]
 
     // ELSE if using a custom provider, pass the provider call as an argument:
@@ -300,7 +300,7 @@ Key changes:
 </Step>
 
 <Step>
-### Update the API Route
+### Update the API route
 
 Remove the agent call that we just extracted, and replace it with a call to `start()` to run the workflow:
 
@@ -330,7 +330,7 @@ Key changes:
 </Step>
 
 <Step>
-### Convert Tools to Steps
+### Convert tools to steps
 
 Mark all tool definitions with `"use step"` to make them durable. This enables automatic retries and observability for each tool call:
 
@@ -389,7 +389,7 @@ With `"use step"`:
 
 </Steps>
 
-That's all you need to do to convert your basic AI SDK agent into a durable agent. If you run your development server, and send a chat message, you should see your agent respond just as before, but now with added durability and observability.
+Your basic AI SDK agent is now durable. Run your development server and send a chat message. The agent should respond as before, with added durability and observability.
 
 ## Observability
 
@@ -401,7 +401,7 @@ npx workflow web
 
 This opens a local dashboard showing all workflow runs and their status, as well as a trace viewer to inspect the workflow in detail, including retry attempts, and the data being passed between steps.
 
-## Next Steps
+## Next steps
 
 Now that you have a basic durable agent, it's a only a short step to add these additional features:
 
@@ -420,11 +420,11 @@ Now that you have a basic durable agent, it's a only a short step to add these a
   </Card>
 </Cards>
 
-## Complete Example
+## Complete example
 
 A complete example that includes all of the above, plus all of the "next steps" features is available on the main branch of the [Flight Booking Agent](https://github.com/vercel/workflow-examples/tree/main/flight-booking-app) example.
 
-## Related Documentation
+## Related documentation
 
 - [Tools](/docs/ai/defining-tools) - Patterns for defining tools for your agent
 - [`WorkflowAgent`](https://ai-sdk.dev/v7/docs/agents/workflow-agent#workflowagent) - AI SDK API for durable, resumable agents

package/docs/ai/message-queueing.mdx

@@ -15,7 +15,7 @@ When using [multi-turn workflows](/docs/ai/chat-session-modeling#multi-turn-work
 
 `WorkflowAgent`'s `prepareStep` callback enables this by running before each step in the agent loop, giving you a chance to inject queued messages into the conversation. `prepareStep` also allows you to modify the model choice and existing messages mid-turn, see AI SDK's [prepareStep callback](https://ai-sdk.dev/docs/agents/loop-control#prepare-step) for more details.
 
-## When to Use This
+## When to use this
 
 Message queueing is useful when:
 
@@ -24,10 +24,10 @@ Message queueing is useful when:
 - You want messages to influence the agent's next step rather than waiting for the current turn to complete
 
 <Callout type="info">
-If you just need basic multi-turn conversations where messages arrive between turns, see [Chat Session Modeling](/docs/ai/chat-session-modeling). This guide covers the more advanced case of injecting messages *during* turns.
+If you need basic multi-turn conversations where messages arrive between turns, see [Chat Session Modeling](/docs/ai/chat-session-modeling). This guide covers the more advanced case of injecting messages *during* turns.
 </Callout>
 
-## The `prepareStep` Callback
+## The `prepareStep` callback
 
 The `prepareStep` callback runs before each step in the agent loop. It receives the current state and can modify the messages sent to the model:
 
@@ -47,7 +47,7 @@ interface PrepareStepResult {
 }
 ```
 
-## Injecting Queued Messages
+## Injecting queued messages
 
 Once you have a [multi-turn workflow](/docs/ai/chat-session-modeling#multi-turn-workflows), you can combine a message queue with `prepareStep` to inject messages that arrive during processing:
 
@@ -106,7 +106,7 @@ Messages sent via `chatMessageHook.resume()` accumulate in the queue and get inj
 The `prepareStep` callback receives messages in `ModelMessage[]` format (with content arrays), which is the internal format used by the AI SDK.
 </Callout>
 
-## Combining with Multi-Turn Sessions
+## Combining with multi-turn sessions
 
 You can also combine message queueing with the standard multi-turn pattern:
 
@@ -169,7 +169,7 @@ export async function chat(initialMessages: ModelMessage[]) {
 }
 ```
 
-## Related Documentation
+## Related documentation
 
 - [Chat Session Modeling](/docs/ai/chat-session-modeling) - Single-turn vs multi-turn patterns
 - [Building Durable AI Agents](/docs/ai) - Complete guide to creating durable agents

package/docs/ai/meta.json

@@ -7,6 +7,7 @@
     "sleep-and-delays",
     "human-in-the-loop",
     "defining-tools",
+    "message-queueing",
     "chat-session-modeling"
   ],
   "defaultOpen": true