@ai-sdk/provider-utils 4.0.24 → 4.0.26

package/src/types/model-message.ts

@@ -1,7 +1,7 @@
-import { AssistantModelMessage } from './assistant-model-message';
-import { SystemModelMessage } from './system-model-message';
-import { ToolModelMessage } from './tool-model-message';
-import { UserModelMessage } from './user-model-message';
+import type { AssistantModelMessage } from './assistant-model-message';
+import type { SystemModelMessage } from './system-model-message';
+import type { ToolModelMessage } from './tool-model-message';
+import type { UserModelMessage } from './user-model-message';
 
 /**
  * A message that can be used in the `messages` field of a prompt.

package/src/types/provider-options.ts

@@ -1,4 +1,4 @@
-import { SharedV3ProviderOptions } from '@ai-sdk/provider';
+import type { SharedV3ProviderOptions } from '@ai-sdk/provider';
 
 /**
  * Additional provider-specific options.

package/src/types/system-model-message.ts

@@ -1,4 +1,4 @@
-import { ProviderOptions } from './provider-options';
+import type { ProviderOptions } from './provider-options';
 
 /**
  * A system message. It can contain system information.

package/src/types/tool-model-message.ts

@@ -1,6 +1,6 @@
-import { ToolResultPart } from './content-part';
-import { ProviderOptions } from './provider-options';
-import { ToolApprovalResponse } from './tool-approval-response';
+import type { ToolResultPart } from './content-part';
+import type { ProviderOptions } from './provider-options';
+import type { ToolApprovalResponse } from './tool-approval-response';
 
 /**
  * A tool message. It contains the result of one or more tool calls.

package/src/types/tool.ts

@@ -1,8 +1,8 @@
-import { JSONValue } from '@ai-sdk/provider';
-import { FlexibleSchema } from '../schema';
-import { ToolResultOutput } from './content-part';
-import { ModelMessage } from './model-message';
-import { ProviderOptions } from './provider-options';
+import type { JSONValue, SharedV3ProviderMetadata } from '@ai-sdk/provider';
+import type { FlexibleSchema } from '../schema';
+import type { ToolResultOutput } from './content-part';
+import type { ModelMessage } from './model-message';
+import type { ProviderOptions } from './provider-options';
 
 /**
  * Additional options that are sent into each tool call.
@@ -128,6 +128,17 @@ export type Tool<
    */
   providerOptions?: ProviderOptions;
 
+  /**
+   * Optional metadata about the tool itself (e.g. its source).
+   *
+   * Unlike `providerOptions`, this metadata is not sent to the language
+   * model. Instead, it is propagated onto the resulting tool call's
+   * `providerMetadata` so consumers can read it from tool call / result
+   * parts and UI message parts. This is useful for sources of dynamic
+   * tools (e.g. an MCP server) to identify themselves.
+   */
+  providerMetadata?: SharedV3ProviderMetadata;
+
   /**
    * The schema of the input that the tool expects.
    * The language model will use this to generate the input.
@@ -288,6 +299,7 @@ export function dynamicTool(tool: {
   description?: string;
   title?: string;
   providerOptions?: ProviderOptions;
+  providerMetadata?: SharedV3ProviderMetadata;
   inputSchema: FlexibleSchema<unknown>;
   execute: ToolExecuteFunction<unknown, unknown>;
 

package/src/types/user-model-message.ts

@@ -1,5 +1,5 @@
-import { FilePart, ImagePart, TextPart } from './content-part';
-import { ProviderOptions } from './provider-options';
+import type { FilePart, ImagePart, TextPart } from './content-part';
+import type { ProviderOptions } from './provider-options';
 
 /**
  * A user message. It can contain text or a combination of text and images.

package/src/validate-types.ts

@@ -1,5 +1,8 @@
-import { TypeValidationContext, TypeValidationError } from '@ai-sdk/provider';
-import { FlexibleSchema, asSchema } from './schema';
+import {
+  TypeValidationError,
+  type TypeValidationContext,
+} from '@ai-sdk/provider';
+import { asSchema, type FlexibleSchema } from './schema';
 
 /**
  * Validates the types of an unknown object using a schema and