@ai-sdk/provider-utils 4.0.26 → 4.0.27

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @ai-sdk/provider-utils
 
+## 4.0.27
+
+### Patch Changes
+
+- f591416: feat(ai): add toolMetadata for tool specific metdata
+
 ## 4.0.26
 
 ### Patch Changes

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { LanguageModelV3FunctionTool, LanguageModelV3ProviderTool, ImageModelV3File, AISDKError, JSONSchema7, JSONParseError, TypeValidationError, JSONValue, APICallError, LanguageModelV3Prompt, SharedV3ProviderOptions, SharedV3ProviderMetadata, TypeValidationContext } from '@ai-sdk/provider';
+import { LanguageModelV3FunctionTool, LanguageModelV3ProviderTool, ImageModelV3File, AISDKError, JSONSchema7, JSONParseError, TypeValidationError, JSONValue, APICallError, LanguageModelV3Prompt, SharedV3ProviderOptions, JSONObject, TypeValidationContext } from '@ai-sdk/provider';
 import { StandardSchemaV1, StandardJSONSchemaV1 } from '@standard-schema/spec';
 export * from '@standard-schema/spec';
 import * as z3 from 'zod/v3';
@@ -1074,11 +1074,11 @@ type Tool<INPUT extends JSONValue | unknown | never = any, OUTPUT extends JSONVa
      *
      * 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.
+     * `toolMetadata` 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;
+    metadata?: JSONObject;
     /**
      * The schema of the input that the tool expects.
      * The language model will use this to generate the input.
@@ -1206,7 +1206,7 @@ declare function dynamicTool(tool: {
     description?: string;
     title?: string;
     providerOptions?: ProviderOptions;
-    providerMetadata?: SharedV3ProviderMetadata;
+    metadata?: JSONObject;
     inputSchema: FlexibleSchema<unknown>;
     execute: ToolExecuteFunction<unknown, unknown>;
     /**

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { LanguageModelV3FunctionTool, LanguageModelV3ProviderTool, ImageModelV3File, AISDKError, JSONSchema7, JSONParseError, TypeValidationError, JSONValue, APICallError, LanguageModelV3Prompt, SharedV3ProviderOptions, SharedV3ProviderMetadata, TypeValidationContext } from '@ai-sdk/provider';
+import { LanguageModelV3FunctionTool, LanguageModelV3ProviderTool, ImageModelV3File, AISDKError, JSONSchema7, JSONParseError, TypeValidationError, JSONValue, APICallError, LanguageModelV3Prompt, SharedV3ProviderOptions, JSONObject, TypeValidationContext } from '@ai-sdk/provider';
 import { StandardSchemaV1, StandardJSONSchemaV1 } from '@standard-schema/spec';
 export * from '@standard-schema/spec';
 import * as z3 from 'zod/v3';
@@ -1074,11 +1074,11 @@ type Tool<INPUT extends JSONValue | unknown | never = any, OUTPUT extends JSONVa
      *
      * 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.
+     * `toolMetadata` 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;
+    metadata?: JSONObject;
     /**
      * The schema of the input that the tool expects.
      * The language model will use this to generate the input.
@@ -1206,7 +1206,7 @@ declare function dynamicTool(tool: {
     description?: string;
     title?: string;
     providerOptions?: ProviderOptions;
-    providerMetadata?: SharedV3ProviderMetadata;
+    metadata?: JSONObject;
     inputSchema: FlexibleSchema<unknown>;
     execute: ToolExecuteFunction<unknown, unknown>;
     /**

package/dist/index.js

@@ -678,7 +678,7 @@ function withUserAgentSuffix(headers, ...userAgentSuffixParts) {
 }
 
 // src/version.ts
-var VERSION = true ? "4.0.26" : "0.0.0-test";
+var VERSION = true ? "4.0.27" : "0.0.0-test";
 
 // src/get-from-api.ts
 var getOriginalFetch = () => globalThis.fetch;