ai 6.0.41 → 6.0.43

package/docs/07-reference/02-ai-sdk-ui/02-use-completion.mdx

@@ -50,7 +50,7 @@ Allows you to create text completion based capabilities for your application. It
       name: 'id',
       type: 'string',
       description:
-        'An unique identifier for the completion. If not provided, a random one will be generated. When provided, the `useCompletion` hook with the same `id` will have shared states across components. This is useful when you have multiple components showing the same chat stream',
+        'A unique identifier for the completion. If not provided, a random one will be generated. When provided, the `useCompletion` hook with the same `id` will have shared states across components. This is useful when you have multiple components showing the same chat stream',
     },
     {
       name: 'initialInput',

package/docs/08-migration-guides/26-migration-guide-5-0.mdx

@@ -1386,7 +1386,7 @@ const { messages } = useChat({
 });
 ```
 
-For a complete example of sharing chat state across components, see the [Share Chat State Across Components](/docs/cookbook/use-shared-chat-context) recipe.
+For a complete example of sharing chat state across components, see the [Share Chat State Across Components](/cookbook/next/use-shared-chat-context) recipe.
 
 #### Chat Transport Architecture
 
@@ -3104,7 +3104,7 @@ const result = await generateObject({
   }),
   providerOptions: {
     openai: {
-      strictSchemas: true, // default behaviour in AI SDK 4
+      strictSchemas: true, // default behavior in AI SDK 4
     } satisfies OpenAIResponsesProviderOptions,
   },
 });
@@ -3122,7 +3122,7 @@ const result = await generateObject({
   }),
   providerOptions: {
     openai: {
-      strictJsonSchema: true, // defaults to false, opt back in to the AI SDK 4 strict behaviour
+      strictJsonSchema: true, // defaults to false, opt back in to the AI SDK 4 strict behavior
     } satisfies OpenAIResponsesProviderOptions,
   },
 });

package/docs/09-troubleshooting/15-abort-breaks-resumable-streams.mdx

@@ -45,7 +45,7 @@ If you need to allow users to stop streams manually:
 ```tsx
 const { messages, sendMessage, stop } = useChat({
   id: chatId,
-  resume: false, // Disable stream resumption (default behaviour)
+  resume: false, // Disable stream resumption (default behavior)
 });
 ```
 

package/docs/09-troubleshooting/21-missing-tool-results-error.mdx

@@ -0,0 +1,82 @@
+---
+title: Missing Tool Results Error
+description: How to fix the "Tool results are missing for tool calls" error when using the AI SDK.
+---
+
+# Missing Tool Results Error
+
+## Issue
+
+You encounter the error `AI_MissingToolResultsError` with a message like:
+
+> Tool results are missing for tool calls: ...
+
+## Cause
+
+This error occurs when you attempt to send a new message to the Large Language Model (LLM) while there are pending tool calls from a previous turn that have not yet been resolved.
+
+The AI SDK core logic validates that all `tool-call` parts in the conversation history are resolved before proceeding. "Resolved" typically means:
+
+1. The tool has been executed and a `tool-result` has been added to the history.
+2. Or, the tool call has triggered a `tool-approval-response` (if using tool approvals).
+
+If a tool call is found without a corresponding result or approval response, this error is thrown to prevent sending an invalid conversation history to the model.
+
+## Solution
+
+Ensure that every tool call in your conversation history is properly handled.
+
+### 1. Provide Tool Results
+
+For standard tool calls, ensure that you provide the output of the tool execution.
+
+```typescript
+const messages = [
+  { role: 'user', content: 'What is the weather in NY?' },
+  {
+    role: 'assistant',
+    content: [
+      {
+        type: 'tool-call',
+        toolCallId: 'call_123',
+        toolName: 'getWeather',
+        args: { location: 'New York' },
+      },
+    ],
+  },
+  // You MUST include this tool message with the result:
+  {
+    role: 'tool',
+    content: [
+      {
+        type: 'tool-result',
+        toolCallId: 'call_123',
+        toolName: 'getWeather',
+        result: 'Sunny, 25°C',
+      },
+    ],
+  },
+  // Now you can add a new user message
+  { role: 'user', content: 'And in London?' },
+];
+```
+
+### 2. Handle Tool Approvals
+
+If you are using the tool approval workflow, ensure that you include the `tool-approval-response`.
+
+```typescript
+const messages = [
+  // ... assistant requests tool execution (needs approval)
+  {
+    role: 'tool',
+    content: [
+      {
+        type: 'tool-approval-response',
+        approvalId: 'approval_123',
+        approved: true, // or false
+      },
+    ],
+  },
+];
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ai",
-  "version": "6.0.41",
+  "version": "6.0.43",
   "description": "AI SDK by Vercel - The AI Toolkit for TypeScript and JavaScript",
   "license": "Apache-2.0",
   "sideEffects": false,
@@ -42,7 +42,7 @@
   },
   "dependencies": {
     "@opentelemetry/api": "1.9.0",
-    "@ai-sdk/gateway": "3.0.16",
+    "@ai-sdk/gateway": "3.0.17",
     "@ai-sdk/provider": "3.0.4",
     "@ai-sdk/provider-utils": "4.0.8"
   },

package/src/error/index.ts

@@ -19,6 +19,7 @@ export { InvalidStreamPartError } from './invalid-stream-part-error';
 export { InvalidToolApprovalError } from './invalid-tool-approval-error';
 export { InvalidToolInputError } from './invalid-tool-input-error';
 export { ToolCallNotFoundForApprovalError } from './tool-call-not-found-for-approval-error';
+export { MissingToolResultsError } from './missing-tool-result-error';
 export { NoImageGeneratedError } from './no-image-generated-error';
 export { NoObjectGeneratedError } from './no-object-generated-error';
 export { NoOutputGeneratedError } from './no-output-generated-error';
@@ -27,7 +28,6 @@ export { NoSuchToolError } from './no-such-tool-error';
 export { ToolCallRepairError } from './tool-call-repair-error';
 export { UnsupportedModelVersionError } from './unsupported-model-version-error';
 export { UIMessageStreamError } from './ui-message-stream-error';
-
 export { InvalidDataContentError } from '../prompt/invalid-data-content-error';
 export { InvalidMessageRoleError } from '../prompt/invalid-message-role-error';
 export { MessageConversionError } from '../prompt/message-conversion-error';

package/src/error/missing-tool-result-error.ts

@@ -0,0 +1,28 @@
+import { AISDKError } from '@ai-sdk/provider';
+
+const name = 'AI_MissingToolResultsError';
+const marker = `vercel.ai.error.${name}`;
+const symbol = Symbol.for(marker);
+
+export class MissingToolResultsError extends AISDKError {
+  private readonly [symbol] = true;
+
+  readonly toolCallIds: string[];
+
+  constructor({ toolCallIds }: { toolCallIds: string[] }) {
+    super({
+      name,
+      message: `Tool result${
+        toolCallIds.length > 1 ? 's are' : ' is'
+      } missing for tool call${toolCallIds.length > 1 ? 's' : ''} ${toolCallIds.join(
+        ', ',
+      )}.`,
+    });
+
+    this.toolCallIds = toolCallIds;
+  }
+
+  static isInstance(error: unknown): error is MissingToolResultsError {
+    return AISDKError.hasMarker(error, marker);
+  }
+}

package/src/prompt/__snapshots__/convert-to-language-model-prompt.validation.test.ts.snap

@@ -0,0 +1,76 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`tool validation > should pass validation for provider-executed tools (deferred results) 1`] = `
+[
+  {
+    "content": [
+      {
+        "input": {
+          "code": "print("hello")",
+        },
+        "providerExecuted": true,
+        "providerOptions": undefined,
+        "toolCallId": "call_1",
+        "toolName": "code_interpreter",
+        "type": "tool-call",
+      },
+    ],
+    "providerOptions": undefined,
+    "role": "assistant",
+  },
+]
+`;
+
+exports[`tool validation > should pass validation for tool-approval-response 1`] = `
+[
+  {
+    "content": [
+      {
+        "input": {
+          "action": "delete_db",
+        },
+        "providerExecuted": undefined,
+        "providerOptions": undefined,
+        "toolCallId": "call_to_approve",
+        "toolName": "dangerous_action",
+        "type": "tool-call",
+      },
+    ],
+    "providerOptions": undefined,
+    "role": "assistant",
+  },
+]
+`;
+
+exports[`tool validation > should preserve provider-executed tool-approval-response 1`] = `
+[
+  {
+    "content": [
+      {
+        "input": {
+          "action": "execute",
+        },
+        "providerExecuted": true,
+        "providerOptions": undefined,
+        "toolCallId": "call_provider_executed",
+        "toolName": "mcp_tool",
+        "type": "tool-call",
+      },
+    ],
+    "providerOptions": undefined,
+    "role": "assistant",
+  },
+  {
+    "content": [
+      {
+        "approvalId": "approval_provider",
+        "approved": true,
+        "reason": undefined,
+        "type": "tool-approval-response",
+      },
+    ],
+    "providerOptions": undefined,
+    "role": "tool",
+  },
+]
+`;

package/src/prompt/convert-to-language-model-prompt.ts

@@ -29,6 +29,7 @@ import { convertToLanguageModelV3DataContent } from './data-content';
 import { InvalidMessageRoleError } from './invalid-message-role-error';
 import { StandardizedPrompt } from './standardize-prompt';
 import { asArray } from '../util/as-array';
+import { MissingToolResultsError } from '../error/missing-tool-result-error';
 
 export async function convertToLanguageModelPrompt({
   prompt,
@@ -45,6 +46,38 @@ export async function convertToLanguageModelPrompt({
     supportedUrls,
   );
 
+  const approvalIdToToolCallId = new Map<string, string>();
+  for (const message of prompt.messages) {
+    if (message.role === 'assistant' && Array.isArray(message.content)) {
+      for (const part of message.content) {
+        if (
+          part.type === 'tool-approval-request' &&
+          'approvalId' in part &&
+          'toolCallId' in part
+        ) {
+          approvalIdToToolCallId.set(
+            part.approvalId as string,
+            part.toolCallId as string,
+          );
+        }
+      }
+    }
+  }
+
+  const approvedToolCallIds = new Set<string>();
+  for (const message of prompt.messages) {
+    if (message.role === 'tool') {
+      for (const part of message.content) {
+        if (part.type === 'tool-approval-response') {
+          const toolCallId = approvalIdToToolCallId.get(part.approvalId);
+          if (toolCallId) {
+            approvedToolCallIds.add(toolCallId);
+          }
+        }
+      }
+    }
+  }
+
   const messages = [
     ...(prompt.system != null
       ? typeof prompt.system === 'string'
@@ -76,7 +109,58 @@ export async function convertToLanguageModelPrompt({
     }
   }
 
-  return combinedMessages;
+  const toolCallIds = new Set<string>();
+
+  for (const message of combinedMessages) {
+    switch (message.role) {
+      case 'assistant': {
+        for (const content of message.content) {
+          if (content.type === 'tool-call' && !content.providerExecuted) {
+            toolCallIds.add(content.toolCallId);
+          }
+        }
+        break;
+      }
+      case 'tool': {
+        for (const content of message.content) {
+          if (content.type === 'tool-result') {
+            toolCallIds.delete(content.toolCallId);
+          }
+        }
+        break;
+      }
+      case 'user':
+      case 'system':
+        // remove approved tool calls from the set before checking:
+        for (const id of approvedToolCallIds) {
+          toolCallIds.delete(id);
+        }
+
+        if (toolCallIds.size > 0) {
+          throw new MissingToolResultsError({
+            toolCallIds: Array.from(toolCallIds),
+          });
+        }
+        break;
+    }
+  }
+
+  // remove approved tool calls from the set before checking:
+  for (const id of approvedToolCallIds) {
+    toolCallIds.delete(id);
+  }
+
+  if (toolCallIds.size > 0) {
+    throw new MissingToolResultsError({ toolCallIds: Array.from(toolCallIds) });
+  }
+
+  return combinedMessages.filter(
+    // Filter out empty tool messages (e.g. if they only contained
+    // tool-approval-response parts that were removed).
+    // This prevents sending invalid empty messages to the provider.
+    // Note: provider-executed tool-approval-response parts are preserved.
+    message => message.role !== 'tool' || message.content.length > 0,
+  );
 }
 
 /**

package/src/prompt/convert-to-language-model-prompt.validation.test.ts

@@ -0,0 +1,138 @@
+import { describe, expect, it } from 'vitest';
+import { convertToLanguageModelPrompt } from './convert-to-language-model-prompt';
+import { MissingToolResultsError } from '../error/missing-tool-result-error';
+
+describe('tool validation', () => {
+  it('should pass validation for provider-executed tools (deferred results)', async () => {
+    const result = await convertToLanguageModelPrompt({
+      prompt: {
+        messages: [
+          {
+            role: 'assistant',
+            content: [
+              {
+                type: 'tool-call',
+                toolCallId: 'call_1',
+                toolName: 'code_interpreter',
+                input: { code: 'print("hello")' },
+                providerExecuted: true,
+              },
+            ],
+          },
+        ],
+      },
+      supportedUrls: {},
+      download: undefined,
+    });
+
+    expect(result).toMatchSnapshot();
+  });
+
+  it('should pass validation for tool-approval-response', async () => {
+    const result = await convertToLanguageModelPrompt({
+      prompt: {
+        messages: [
+          {
+            role: 'assistant',
+            content: [
+              {
+                type: 'tool-call',
+                toolCallId: 'call_to_approve',
+                toolName: 'dangerous_action',
+                input: { action: 'delete_db' },
+              },
+              {
+                type: 'tool-approval-request',
+                toolCallId: 'call_to_approve',
+                approvalId: 'approval_123',
+                toolName: 'dangerous_action',
+                input: { action: 'delete_db' },
+              } as any,
+            ],
+          },
+          {
+            role: 'tool',
+            content: [
+              {
+                type: 'tool-approval-response',
+                approvalId: 'approval_123',
+                approved: true,
+              } as any,
+            ],
+          },
+        ],
+      },
+      supportedUrls: {},
+      download: undefined,
+    });
+
+    expect(result).toMatchSnapshot();
+  });
+
+  it('should preserve provider-executed tool-approval-response', async () => {
+    const result = await convertToLanguageModelPrompt({
+      prompt: {
+        messages: [
+          {
+            role: 'assistant',
+            content: [
+              {
+                type: 'tool-call',
+                toolCallId: 'call_provider_executed',
+                toolName: 'mcp_tool',
+                input: { action: 'execute' },
+                providerExecuted: true,
+              },
+              {
+                type: 'tool-approval-request',
+                toolCallId: 'call_provider_executed',
+                approvalId: 'approval_provider',
+                toolName: 'mcp_tool',
+                input: { action: 'execute' },
+              } as any,
+            ],
+          },
+          {
+            role: 'tool',
+            content: [
+              {
+                type: 'tool-approval-response',
+                approvalId: 'approval_provider',
+                approved: true,
+                providerExecuted: true,
+              },
+            ],
+          },
+        ],
+      },
+      supportedUrls: {},
+      download: undefined,
+    });
+
+    expect(result).toMatchSnapshot();
+  });
+
+  it('should throw error for actual missing results', async () => {
+    await expect(async () => {
+      await convertToLanguageModelPrompt({
+        prompt: {
+          messages: [
+            {
+              role: 'assistant',
+              content: [
+                {
+                  type: 'tool-call',
+                  toolCallId: 'call_missing_result',
+                  toolName: 'regular_tool',
+                  input: {},
+                },
+              ],
+            },
+          ],
+        },
+        supportedUrls: {},
+        download: undefined,
+      });
+    }).rejects.toThrow(MissingToolResultsError);
+  });
+});