Skip to content

docs: add AI SDK 7 Beta announcement and rebrand Workflow references#14520

Open
nicoalbanese wants to merge 20 commits intomainfrom
na/6ccf9d81
Open

docs: add AI SDK 7 Beta announcement and rebrand Workflow references#14520
nicoalbanese wants to merge 20 commits intomainfrom
na/6ccf9d81

Conversation

@nicoalbanese
Copy link
Copy Markdown
Collaborator

@nicoalbanese nicoalbanese commented Apr 16, 2026

Summary

Add AI SDK 7 Beta announcement page with comprehensive documentation on new features, update Workflow-related docs to reference the Workflow SDK instead of Vercel Workflows, and replace hardcoded model names with placeholders in code examples.

Changes

New: AI SDK 7 Beta announcement (content/docs/00-introduction/01-announcing-ai-sdk-7-beta.mdx)

  • Full announcement page covering WorkflowAgent, overhauled telemetry, top-level reasoning, file/skill uploads, typed tool context, and granular timeout controls
  • Includes installation instructions, beta guidance, code examples, and migration pointers

Introduction page (content/docs/00-introduction/index.mdx)

  • Add note linking to the AI SDK 7 Beta announcement

Migration guides (content/docs/08-migration-guides/index.mdx)

  • Add AI SDK 6.x to 7.0 migration guide entry

Rebrand: Vercel Workflows -> Workflow SDK (across 7 files)

  • content/docs/03-agents/07-workflow-agent.mdx — Update description, comparison table, and runtime references
  • content/docs/03-agents/index.mdx — Update WorkflowAgent card description
  • content/docs/04-ai-sdk-ui/21-transport.mdx — Update Workflow Transport section
  • content/docs/07-reference/04-ai-sdk-workflow/01-workflow-agent.mdx — Update class description and reference text
  • content/docs/07-reference/04-ai-sdk-workflow/02-workflow-chat-transport.mdx — Update transport description
  • content/docs/07-reference/04-ai-sdk-workflow/index.mdx — Update package overview

Code example cleanup

  • Replace hardcoded model/provider names with __MODEL__ and __PROVIDER_IMPORT__ placeholders in announcement page examples

Chat - Built with guidance from Nico Albanese

nicoalbanese and others added 3 commits April 16, 2026 11:00
Co-Authored-By: open-agents-bot[bot] <260704009+open-agents-bot[bot]@users.noreply.github.com>
Co-Authored-By: open-agents-bot[bot] <260704009+open-agents-bot[bot]@users.noreply.github.com>
Co-Authored-By: open-agents-bot[bot] <260704009+open-agents-bot[bot]@users.noreply.github.com>
@tigent tigent Bot added documentation Improvements or additions to documentation maintenance CI, internal documentation, automations, etc labels Apr 16, 2026
Co-Authored-By: open-agents-bot[bot] <260704009+open-agents-bot[bot]@users.noreply.github.com>
Co-Authored-By: open-agents-bot[bot] <260704009+open-agents-bot[bot]@users.noreply.github.com>
Co-Authored-By: open-agents-bot[bot] <260704009+open-agents-bot[bot]@users.noreply.github.com>
Co-Authored-By: open-agents-bot[bot] <260704009+open-agents-bot[bot]@users.noreply.github.com>
Co-Authored-By: open-agents-bot[bot] <260704009+open-agents-bot[bot]@users.noreply.github.com>
Co-Authored-By: open-agents-bot[bot] <260704009+open-agents-bot[bot]@users.noreply.github.com>
Co-Authored-By: open-agents-bot[bot] <260704009+open-agents-bot[bot]@users.noreply.github.com>
Co-Authored-By: open-agents-bot[bot] <260704009+open-agents-bot[bot]@users.noreply.github.com>
Co-Authored-By: open-agents-bot[bot] <260704009+open-agents-bot[bot]@users.noreply.github.com>
Co-Authored-By: open-agents-bot[bot] <260704009+open-agents-bot[bot]@users.noreply.github.com>
@nicoalbanese nicoalbanese changed the title docs: add AI SDK 7 Beta announcement and documentation updates docs: add AI SDK 7 Beta announcement and rebrand Workflow references Apr 16, 2026
Co-Authored-By: open-agents-bot[bot] <260704009+open-agents-bot[bot]@users.noreply.github.com>

### Stable Typed Tool Context

AI SDK 7 promotes `experimental_context` to stable `context` and lets tools declare a `contextSchema` for end-to-end type inference.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was just enhanced in #14515, may be good to mention that context is separated by tool and must be passed via toolsContext.

Comment thread content/docs/00-introduction/01-announcing-ai-sdk-7-beta.mdx
nicoalbanese and others added 2 commits April 16, 2026 14:27
Co-Authored-By: open-agents-bot[bot] <260704009+open-agents-bot[bot]@users.noreply.github.com>

### Overhauled Telemetry

AI SDK 7 overhauls telemetry to make observability much easier to adopt. OpenTelemetry support now lives in the new `@ai-sdk/otel` package, and setup is simple: register an integration once, then enable telemetry on the calls you want to trace.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

then enable telemetry on the calls you want to trace.

this will change after PR #14500.

Telemetry will be enabled by default for all calls and will opt-out!

const result = streamText({
model: __MODEL__,
prompt: "Summarize today's release notes.",
experimental_telemetry: { isEnabled: true },
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this line won't be needed!

import { GenAIOpenTelemetryIntegration } from '@ai-sdk/otel';
__PROVIDER_IMPORT__;

registerTelemetryIntegration(new GenAIOpenTelemetryIntegration());
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would be good to mention that this only needs to happen on app startup

Copy link
Copy Markdown
Contributor

@gr2m gr2m left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we mention the tracking issue? Folks can subscribe to it for updates. I'll post weekly updates to it: #14011

Comment on lines +55 to +59
__PROVIDER_IMPORT__;
import { z } from 'zod';

export const supportAgent = new WorkflowAgent({
model: __MODEL__,
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I would use an example provider here. Being able to use the providers just like ToolLoopAgent is one of the main improvements over DurableAgent

Suggested change
__PROVIDER_IMPORT__;
import { z } from 'zod';
export const supportAgent = new WorkflowAgent({
model: __MODEL__,
import { openai } from '@ai-sdk/openai';
import { z } from 'zod';
export const supportAgent = new WorkflowAgent({
model: openai('gpt-5.4-pro'),

Comment on lines +67 to +70
execute: async ({ orderId }) => ({
orderId,
status: 'shipped',
}),
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this would usually be a step function.

Suggested change
execute: async ({ orderId }) => ({
orderId,
status: 'shipped',
}),
execute: async ({ orderId }) => {
'use step';
/* look up order in database */
return {
orderId,
status: 'shipped',
}
},

Comment on lines +192 to +213
### Stable Typed Tool Context

AI SDK 7 promotes `experimental_context` to stable `context` and lets each tool declare its own `contextSchema` for end-to-end type inference. Context is separated by tool — each tool only receives the context it declares, and the call-site `context` is type-checked against the combined requirements of all tools.

```ts
import { tool } from 'ai';
import { z } from 'zod';

const weather = tool({
inputSchema: z.object({
location: z.string(),
}),
contextSchema: z.object({
weatherApiKey: z.string(),
}),
execute: async ({ location }, { context: { weatherApiKey } }) => {
return getWeather(location, weatherApiKey);
},
});
```

This typed context also flows into approval callbacks and other tool lifecycle hooks. See the [migration guide](/docs/migration-guides/migration-guide-7-0) for upgrade details.
Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is still undergoing significant changes (example is already outdated)

### `reasoning-file` Content Part

Models that return files as part of their reasoning trace (separate from regular output files) now use a distinct `reasoning-file` content part type. Previously these were grouped under the generic `file` type. If you have exhaustive part handling (`switch` statements, renderers, serializers), you will need to add a case for `type: 'reasoning-file'`.

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there is also the new top level toolNeedsApproval setting for agent, generateText, streamText

Copy link
Copy Markdown
Contributor

@gr2m gr2m Apr 16, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nicoalbanese and others added 2 commits April 21, 2026 14:52
Co-Authored-By: open-agents-bot[bot] <260704009+open-agents-bot[bot]@users.noreply.github.com>
Co-Authored-By: open-agents-bot[bot] <260704009+open-agents-bot[bot]@users.noreply.github.com>
Co-Authored-By: open-agents-bot[bot] <260704009+open-agents-bot[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation maintenance CI, internal documentation, automations, etc

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants