AG-UI TOOL_CALL_RESULT metadata is dropped in the live stream reducer

未关闭
  • 哪里不对？
#2,068 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

@c446984928 已经在做这个了。

开始于 2026年11月6日。

  • #2069 来自 @c446984928 —— 未关闭

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
35/100
Issue 类型
缺陷
描述清晰度
描述清楚
活跃度
停滞
技术栈
typescript
领域
api, backend

调研方向

Read packages/ai/src/activities/chat/stream/processor.ts and packages/ai/src/activities/chat/stream/message-updaters.ts, then compare with the snapshot conversion in packages/ai/src/activities/chat/messages.ts. Check the existing tests for live tool result events and add coverage for metadata preservation on creation and update; done means live results retain metadata consistently with hydrated snapshots. An open linked pull request already covers this issue.

由索引模型根据 Issue 内容生成。

描述

Summary

The live AG-UI TOOL_CALL_RESULT handling path drops the event's metadata when constructing the ToolResultPart.

This makes metadata behave inconsistently between live streaming and message snapshot/history hydration: a ToolMessage.metadata received in a MESSAGES_SNAPSHOT can be preserved, but the same metadata delivered on a live TOOL_CALL_RESULT is not available on the resulting UIMessage.parts entry.

Expected behavior

When a TOOL_CALL_RESULT event contains metadata, the resulting ToolResultPart should retain it:

{
  type: 'tool-result',
  toolCallId: 'call-123',
  content: '...',
  state: 'complete',
  metadata: {
    displayType: 'account-assets',
  },
}

Actual behavior

In packages/ai/src/activities/chat/stream/processor.ts, handleToolCallResultEvent() receives the full event, but calls updateToolResultPart() without forwarding chunk.metadata.

In packages/ai/src/activities/chat/stream/message-updaters.ts, updateToolResultPart() constructs a ToolResultPart containing content, state, error, and outcome, but does not set metadata.

The public ToolResultPart type in packages/ai/src/types.ts already declares metadata?: Record<string, unknown>, and the snapshot conversion path in packages/ai/src/activities/chat/messages.ts preserves metadata from tool messages. So the type and snapshot path support this field, but the live event reducer currently drops it.

Reproduction

  1. Stream an AG-UI TOOL_CALL_RESULT event with a metadata object:

    {
  "type": "TOOL_CALL_RESULT",
  "messageId": "assistant-1",
  "toolCallId": "call-123",
  "content": "{\"ok\":true}",
  "metadata": {
    "displayType": "account-assets"
  }
}

  2. Observe the resulting UIMessage.parts entry with type === 'tool-result'.

  3. The content is present, but metadata is missing.

Suggested fix

Forward the event metadata into updateToolResultPart() and persist it on the created ToolResultPart. Please also consider how metadata should be merged when an existing tool-result part is updated, so an update does not accidentally discard previously stored metadata.

Add a regression test covering:

  • Live TOOL_CALL_RESULT.metadata is retained in ToolResultPart.metadata.
  • Snapshot/history hydration and live streaming produce consistent metadata.
  • Updating an existing tool-result part does not unintentionally lose metadata.

Relevant code

Thanks!

主要语言
TypeScript
星标
3.3k
派生
378
平均合并
1 天 2 小时
30 天内合并 PR
254

环境准备

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

TanStack/ai 的其他 Issue

查看 TanStack/ai 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。