How should custom data- parts stream with WorkflowAgent?

Open
#5,377 1 comment 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
46/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Active
Tech stack
typescript

Research direction

Start with the WorkflowAgent migration notes, the Streaming Updates from Tools documentation, and the createModelCallToUIChunkTransform implementation mentioned in the issue. Compare the transform behavior with workflow-examples PR #53 and investigate how stream parts relate to result.steps and WorkflowChatTransport reconnects. Done means documenting or implementing a supported way to stream, reconnect, and persist custom data parts, including those emitted outside tool calls.

Written by the indexing model from the issue text.

Description

We're moving a multi-turn agent from DurableAgent to WorkflowAgent (ai 7.0.163, @ai-sdk/workflow 2.0.95, workflow 5.4.0). We follow the chat-session-modeling and message-queueing docs: one long-lived run per chat, a hook feeding a queue, prepareStep draining it, and createModelCallToUIChunkTransform at the route.

Our workflow writes app-specific data-* parts to the run stream. Some come from inside tools, but many come from steps outside any tool call.

On DurableAgent they streamed live next to the model output. On WorkflowAgent, createModelCallToUIChunkTransform maps any part type it doesn't know to nothing, so they're dropped. We confirmed this in a test app and in the transform's source.

Questions:

  1. What's the recommended way to show custom data-* parts live with WorkflowAgent, including parts written from steps outside a tool call, so they also survive a reconnect with WorkflowChatTransport? Is passing data-* through the transform, as PR #53 does, supported?
  2. How do we save and persist these custom data parts? It’s not captured as part of the result.steps from WorkflowAgent.

What we've found:

  • The Streaming Updates from Tools page still says to write data-* chunks with getWritable() into the agent's stream. With the stock transform, those never reach the client.
  • The v7 migration notes say the stream moved to ModelCallStreamPart "to avoid baking a UI protocol into the workflow payload". They don't say where custom UI data should go instead.
  • workflow-examples PR #53 (flight-booking-app, closed without merging) copies the transform into lib/chat-stream.ts and forwards data-* parts unchanged.
  • eve and durable-harness sidestep the question. Neither uses WorkflowAgent: each runs ToolLoopAgent inside its own session runtime on Workflow 5 and writes its own event protocol to the run stream.
Dominant language
TypeScript
Stars
2.5k
Forks
401
Avg merge
1d 21h
Merged PRs (30d)
201

Getting set up

  • No Dockerfile or Docker Compose file
  • Has a pull request template
  • No contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from vercel/workflow

All issues in vercel/workflow

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.