fix(ai): v5: preserve providerMetadata on invalid tool calls and tool results (#10733)

Und3rf10w · web-flow · commit 1063acac7bd8 · 2025-12-01T11:40:48.000+01:00
## Background Provider metadata (such as Google Gemini's `thoughtSignature`) was being lost in two scenarios: 1. **Tool result propagation**: When tool results were converted to model messages, the `callProviderMetadata` from tool UI parts was not being propagated to tool-result parts. This was fixed in main branch (PR #10361, merged November 19, 2025) but not backported to v5.0. 2. **Invalid tool call handling**: When a tool call failed input validation (e.g., Zod schema mismatch), the error handler was creating an invalid tool call object without preserving the `providerMetadata` field from the original tool call. This is particularly problematic for providers like Google Gemini that use provider metadata to track `thoughtSignature` through reasoning and tool execution cycles. ## Summary  This PR includes two related fixes for provider metadata preservation on the `release-v5.0` branch: ### Fix 1: Tool Result Metadata Propagation (Backport from main) Backported changes ensure that `callProviderMetadata` from tool UI parts is correctly propagated to tool-result parts as `providerOptions` in two locations: 1. **Provider-executed tool results** (within assistant message content) - [convert-to-model-messages.ts:223-225](packages/ai/src/ui/convert-to-model-messages.ts#L223-L225) 2. **Client-executed tool results** (in separate tool messages) - [convert-to-model-messages.ts:281-283](packages/ai/src/ui/convert-to-model-messages.ts#L281-L283) ### Fix 2: Invalid Tool Call Metadata Preservation (New) Added `providerMetadata` preservation in the error handler of `parse-tool-call.ts` (line 88). When tool input validation fails, the invalid tool call object now includes the `providerMetadata` from the original `LanguageModelV2ToolCall`, matching the behavior of the success path. **File**: [packages/ai/src/generate-text/parse-tool-call.ts:88](packages/ai/src/generate-text/parse-tool-call.ts#L88) Both fixes ensure consistency in how provider metadata flows through the entire tool execution lifecycle (tool-call → tool-result) and error paths. ## Manual Verification Added comprehensive test coverage: - Client-executed tool result with provider metadata - Provider-executed tool result with provider metadata - Error state tool result with provider metadata - Dynamic tool result with provider metadata - Updated existing test snapshot to reflect the fix In addition, I manually ran: [google-vertex-code-execution.](examples/ai-core/src/stream-text/google-vertex-code-execution.ts) [google-vertex-fullstream](examples/ai-core/src/stream-text/google-vertex-fullstream.ts) [google-vertex-grounding](examples/ai-core/src/stream-text/google-vertex-grounding.ts) with both the `gemini-3-pro-preview` and `gemini-2.5-pro` models and confirmed they function correctly. Finally, I manually ran the provided reproduction script in #10560, and verified that it works correctly. ## Related Issues Fixes #10560 Fixes #10721 **Related PR:** - #10361 - Original fix in main branch **Potentially Related PRs:** - #10462 - `fix(google): add thought signature to gemini 3 pro image parts` - #10508 - Potentially related to provider metadata handling
diff --git a/.changeset/fresh-insects-vanish.md b/.changeset/fresh-insects-vanish.md
@@ -0,0 +1,5 @@
+---
+'ai': patch
+---
+
+fix(ai): Preverse providerMetadata in tool-call and tool-result parts
diff --git a/packages/ai/src/generate-text/generate-text.test.ts b/packages/ai/src/generate-text/generate-text.test.ts
@@ -3040,6 +3040,7 @@ describe('generateText', () => {
                 "cities": "San Francisco",
               },
               "invalid": true,
+              "providerMetadata": undefined,
               "toolCallId": "call-1",
               "toolName": "cityAttractions",
               "type": "tool-call",
diff --git a/packages/ai/src/generate-text/parse-tool-call.test.ts b/packages/ai/src/generate-text/parse-tool-call.test.ts
@@ -166,6 +166,7 @@ describe('parseToolCall', () => {
         "error": [AI_NoSuchToolError: Model tried to call unavailable tool 'testTool'. No tools are available.],
         "input": {},
         "invalid": true,
+        "providerMetadata": undefined,
         "toolCallId": "123",
         "toolName": "testTool",
         "type": "tool-call",
@@ -200,6 +201,7 @@ describe('parseToolCall', () => {
         "error": [AI_NoSuchToolError: Model tried to call unavailable tool 'nonExistentTool'. Available tools: testTool.],
         "input": {},
         "invalid": true,
+        "providerMetadata": undefined,
         "toolCallId": "123",
         "toolName": "nonExistentTool",
         "type": "tool-call",
@@ -246,6 +248,7 @@ describe('parseToolCall', () => {
           "param1": "test",
         },
         "invalid": true,
+        "providerMetadata": undefined,
         "toolCallId": "123",
         "toolName": "testTool",
         "type": "tool-call",
@@ -342,6 +345,7 @@ describe('parseToolCall', () => {
         Error message: Unexpected token 'i', "invalid json" is not valid JSON],
           "input": "invalid json",
           "invalid": true,
+          "providerMetadata": undefined,
           "toolCallId": "123",
           "toolName": "testTool",
           "type": "tool-call",
@@ -378,6 +382,7 @@ describe('parseToolCall', () => {
           "error": [AI_ToolCallRepairError: Error repairing tool call: test error],
           "input": "invalid json",
           "invalid": true,
+          "providerMetadata": undefined,
           "toolCallId": "123",
           "toolName": "testTool",
           "type": "tool-call",
diff --git a/packages/ai/src/generate-text/parse-tool-call.ts b/packages/ai/src/generate-text/parse-tool-call.ts
@@ -85,6 +85,7 @@ export async function parseToolCall<TOOLS extends ToolSet>({
       dynamic: true,
       invalid: true,
       error,
+      providerMetadata: toolCall.providerMetadata,
     };
   }
 }
diff --git a/packages/ai/src/generate-text/stream-text.test.ts b/packages/ai/src/generate-text/stream-text.test.ts
@@ -13146,6 +13146,7 @@ describe('streamText', () => {
                 "cities": "San Francisco",
               },
               "invalid": true,
+              "providerMetadata": undefined,
               "toolCallId": "call-1",
               "toolName": "cityAttractions",
               "type": "tool-call",
@@ -13218,6 +13219,7 @@ describe('streamText', () => {
                   "cities": "San Francisco",
                 },
                 "invalid": true,
+                "providerMetadata": undefined,
                 "toolCallId": "call-1",
                 "toolName": "cityAttractions",
                 "type": "tool-call",
diff --git a/packages/ai/src/ui/convert-to-model-messages.test.ts b/packages/ai/src/ui/convert-to-model-messages.test.ts
@@ -505,6 +505,217 @@ describe('convertToModelMessages', () => {
                   "type": "text",
                   "value": "3",
                 },
+                "providerOptions": {
+                  "testProvider": {
+                    "signature": "1234567890",
+                  },
+                },
+                "toolCallId": "call1",
+                "toolName": "calculator",
+                "type": "tool-result",
+              },
+            ],
+            "role": "tool",
+          },
+        ]
+      `);
+    });
+
+    it('should propagate provider metadata to tool-result (client-executed)', () => {
+      const result = convertToModelMessages([
+        {
+          role: 'assistant',
+          parts: [
+            { type: 'step-start' },
+            {
+              type: 'tool-calculator',
+              state: 'output-available',
+              toolCallId: 'call1',
+              input: { operation: 'add', numbers: [1, 2] },
+              output: '3',
+              callProviderMetadata: {
+                testProvider: {
+                  executionTime: 100,
+                },
+              },
+            },
+          ],
+        },
+      ]);
+
+      expect(result).toMatchInlineSnapshot(`
+        [
+          {
+            "content": [
+              {
+                "input": {
+                  "numbers": [
+                    1,
+                    2,
+                  ],
+                  "operation": "add",
+                },
+                "providerExecuted": undefined,
+                "providerOptions": {
+                  "testProvider": {
+                    "executionTime": 100,
+                  },
+                },
+                "toolCallId": "call1",
+                "toolName": "calculator",
+                "type": "tool-call",
+              },
+            ],
+            "role": "assistant",
+          },
+          {
+            "content": [
+              {
+                "output": {
+                  "type": "text",
+                  "value": "3",
+                },
+                "providerOptions": {
+                  "testProvider": {
+                    "executionTime": 100,
+                  },
+                },
+                "toolCallId": "call1",
+                "toolName": "calculator",
+                "type": "tool-result",
+              },
+            ],
+            "role": "tool",
+          },
+        ]
+      `);
+    });
+
+    it('should propagate provider metadata to tool-result (provider-executed)', () => {
+      const result = convertToModelMessages([
+        {
+          role: 'assistant',
+          parts: [
+            { type: 'step-start' },
+            {
+              type: 'tool-calculator',
+              state: 'output-available',
+              toolCallId: 'call1',
+              input: { operation: 'subtract', numbers: [10, 5] },
+              output: '5',
+              providerExecuted: true,
+              callProviderMetadata: {
+                testProvider: {
+                  executionTime: 50,
+                },
+              },
+            },
+          ],
+        },
+      ]);
+
+      expect(result).toMatchInlineSnapshot(`
+        [
+          {
+            "content": [
+              {
+                "input": {
+                  "numbers": [
+                    10,
+                    5,
+                  ],
+                  "operation": "subtract",
+                },
+                "providerExecuted": true,
+                "providerOptions": {
+                  "testProvider": {
+                    "executionTime": 50,
+                  },
+                },
+                "toolCallId": "call1",
+                "toolName": "calculator",
+                "type": "tool-call",
+              },
+              {
+                "output": {
+                  "type": "text",
+                  "value": "5",
+                },
+                "providerOptions": {
+                  "testProvider": {
+                    "executionTime": 50,
+                  },
+                },
+                "toolCallId": "call1",
+                "toolName": "calculator",
+                "type": "tool-result",
+              },
+            ],
+            "role": "assistant",
+          },
+        ]
+      `);
+    });
+
+    it('should propagate provider metadata to tool-result with error state', () => {
+      const result = convertToModelMessages([
+        {
+          role: 'assistant',
+          parts: [
+            { type: 'step-start' },
+            {
+              type: 'tool-calculator',
+              state: 'output-error',
+              toolCallId: 'call1',
+              input: { operation: 'divide', numbers: [10, 0] },
+              errorText: 'Error: Division by zero',
+              callProviderMetadata: {
+                testProvider: {
+                  errorCode: 'DIVISION_BY_ZERO',
+                },
+              },
+            },
+          ],
+        },
+      ]);
+
+      expect(result).toMatchInlineSnapshot(`
+        [
+          {
+            "content": [
+              {
+                "input": {
+                  "numbers": [
+                    10,
+                    0,
+                  ],
+                  "operation": "divide",
+                },
+                "providerExecuted": undefined,
+                "providerOptions": {
+                  "testProvider": {
+                    "errorCode": "DIVISION_BY_ZERO",
+                  },
+                },
+                "toolCallId": "call1",
+                "toolName": "calculator",
+                "type": "tool-call",
+              },
+            ],
+            "role": "assistant",
+          },
+          {
+            "content": [
+              {
+                "output": {
+                  "type": "error-text",
+                  "value": "Error: Division by zero",
+                },
+                "providerOptions": {
+                  "testProvider": {
+                    "errorCode": "DIVISION_BY_ZERO",
+                  },
+                },
                 "toolCallId": "call1",
                 "toolName": "calculator",
                 "type": "tool-result",
@@ -1184,6 +1395,72 @@ describe('convertToModelMessages', () => {
         ]
       `);
     });
+
+    it('should propagate provider metadata to dynamic tool-result', () => {
+      const result = convertToModelMessages([
+        {
+          role: 'assistant',
+          parts: [
+            { type: 'step-start' },
+            {
+              type: 'dynamic-tool',
+              toolName: 'custom-tool',
+              state: 'output-available',
+              toolCallId: 'call-dynamic-1',
+              input: { param: 'test' },
+              output: 'dynamic-result',
+              callProviderMetadata: {
+                testProvider: {
+                  dynamicToolExecution: true,
+                },
+              },
+            },
+          ],
+        },
+      ]);
+
+      expect(result).toMatchInlineSnapshot(`
+        [
+          {
+            "content": [
+              {
+                "input": {
+                  "param": "test",
+                },
+                "providerOptions": {
+                  "testProvider": {
+                    "dynamicToolExecution": true,
+                  },
+                },
+                "toolCallId": "call-dynamic-1",
+                "toolName": "custom-tool",
+                "type": "tool-call",
+              },
+            ],
+            "role": "assistant",
+          },
+          {
+            "content": [
+              {
+                "output": {
+                  "type": "text",
+                  "value": "dynamic-result",
+                },
+                "providerOptions": {
+                  "testProvider": {
+                    "dynamicToolExecution": true,
+                  },
+                },
+                "toolCallId": "call-dynamic-1",
+                "toolName": "custom-tool",
+                "type": "tool-result",
+              },
+            ],
+            "role": "tool",
+          },
+        ]
+      `);
+    });
   });
 
   describe('data part conversion', () => {
diff --git a/packages/ai/src/ui/convert-to-model-messages.ts b/packages/ai/src/ui/convert-to-model-messages.ts
@@ -220,6 +220,9 @@ export function convertToModelMessages<UI_MESSAGE extends UIMessage>(
                         errorMode:
                           part.state === 'output-error' ? 'json' : 'none',
                       }),
+                      ...(part.callProviderMetadata != null
+                        ? { providerOptions: part.callProviderMetadata }
+                        : {}),
                     });
                   }
                 }
@@ -278,6 +281,9 @@ export function convertToModelMessages<UI_MESSAGE extends UIMessage>(
                                 ? 'text'
                                 : 'none',
                           }),
+                          ...(toolPart.callProviderMetadata != null
+                            ? { providerOptions: toolPart.callProviderMetadata }
+                            : {}),
                         };
                       }
                       default: {

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +'ai': patch
 +---
++
 +fix(ai): Preverse providerMetadata in tool-call and tool-result parts
Original file line number	Diff line number	Diff line change
`@@ -85,6 +85,7 @@ export async function parseToolCall<TOOLS extends ToolSet>({`
`85`	`85`	`dynamic: true,`
`86`	`86`	`invalid: true,`
`87`	`87`	`error,`
	`88`	`+ providerMetadata: toolCall.providerMetadata,`
`88`	`89`	`};`
`89`	`90`	`}`
`90`	`91`	`}`
Original file line number	Diff line number	Diff line change
`@@ -220,6 +220,9 @@ export function convertToModelMessages<UI_MESSAGE extends UIMessage>(`
`220`	`220`	`errorMode:`
`221`	`221`	`part.state === 'output-error' ? 'json' : 'none',`
`222`	`222`	`}),`
	`223`	`+ ...(part.callProviderMetadata != null`
	`224`	`+ ? { providerOptions: part.callProviderMetadata }`
	`225`	`+ : {}),`
`223`	`226`	`});`
`224`	`227`	`}`
`225`	`228`	`}`
`@@ -278,6 +281,9 @@ export function convertToModelMessages<UI_MESSAGE extends UIMessage>(`
`278`	`281`	`? 'text'`
`279`	`282`	`: 'none',`
`280`	`283`	`}),`
	`284`	`+ ...(toolPart.callProviderMetadata != null`
	`285`	`+ ? { providerOptions: toolPart.callProviderMetadata }`
	`286`	`+ : {}),`
`281`	`287`	`};`
`282`	`288`	`}`
`283`	`289`	`default: {`