ai 6.0.175 → 6.0.176

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (27) hide show
  1. package/CHANGELOG.md +9 -0
  2. package/dist/index.d.mts +18 -0
  3. package/dist/index.d.ts +18 -0
  4. package/dist/index.js +92 -42
  5. package/dist/index.js.map +1 -1
  6. package/dist/index.mjs +95 -43
  7. package/dist/index.mjs.map +1 -1
  8. package/dist/internal/index.js +1 -1
  9. package/dist/internal/index.mjs +1 -1
  10. package/docs/02-foundations/02-providers-and-models.mdx +3 -0
  11. package/docs/07-reference/01-ai-sdk-core/20-tool.mdx +3 -3
  12. package/docs/07-reference/01-ai-sdk-core/22-dynamic-tool.mdx +3 -3
  13. package/docs/07-reference/01-ai-sdk-core/23-create-mcp-client.mdx +9 -1
  14. package/package.json +3 -3
  15. package/src/generate-text/execute-tool-call.ts +6 -0
  16. package/src/generate-text/generate-text.ts +12 -0
  17. package/src/generate-text/parse-tool-call.ts +8 -33
  18. package/src/generate-text/run-tools-transformation.ts +10 -0
  19. package/src/generate-text/stream-text-result.ts +2 -0
  20. package/src/generate-text/stream-text.ts +15 -0
  21. package/src/generate-text/tool-call.ts +2 -0
  22. package/src/generate-text/tool-error.ts +3 -0
  23. package/src/generate-text/tool-result.ts +3 -0
  24. package/src/ui/process-ui-message-stream.ts +29 -1
  25. package/src/ui/ui-messages.ts +3 -0
  26. package/src/ui/validate-ui-messages.ts +25 -1
  27. package/src/ui-message-stream/ui-message-chunks.ts +17 -0
package/CHANGELOG.md CHANGED
@@ -1,5 +1,14 @@
1
1
  # ai
2
2
 
3
+ ## 6.0.176
4
+
5
+ ### Patch Changes
6
+
7
+ - f591416: feat(ai): add toolMetadata for tool specific metdata
8
+ - Updated dependencies [f591416]
9
+ - @ai-sdk/provider-utils@4.0.27
10
+ - @ai-sdk/gateway@3.0.111
11
+
3
12
  ## 6.0.175
4
13
 
5
14
  ### Patch Changes
package/dist/index.d.mts CHANGED
@@ -688,6 +688,7 @@ type BaseToolCall = {
688
688
  toolCallId: string;
689
689
  providerExecuted?: boolean;
690
690
  providerMetadata?: ProviderMetadata;
691
+ toolMetadata?: JSONObject;
691
692
  };
692
693
  type StaticToolCall<TOOLS extends ToolSet> = ValueOf<{
693
694
  [NAME in keyof TOOLS]: BaseToolCall & {
@@ -742,6 +743,7 @@ type StaticToolError<TOOLS extends ToolSet> = ValueOf<{
742
743
  error: unknown;
743
744
  providerExecuted?: boolean;
744
745
  providerMetadata?: ProviderMetadata;
746
+ toolMetadata?: JSONObject;
745
747
  dynamic?: false | undefined;
746
748
  title?: string;
747
749
  };
@@ -754,6 +756,7 @@ type DynamicToolError = {
754
756
  error: unknown;
755
757
  providerExecuted?: boolean;
756
758
  providerMetadata?: ProviderMetadata;
759
+ toolMetadata?: JSONObject;
757
760
  dynamic: true;
758
761
  title?: string;
759
762
  };
@@ -768,6 +771,7 @@ type StaticToolResult<TOOLS extends ToolSet> = ValueOf<{
768
771
  output: InferToolOutput<TOOLS[NAME]>;
769
772
  providerExecuted?: boolean;
770
773
  providerMetadata?: ProviderMetadata;
774
+ toolMetadata?: JSONObject;
771
775
  dynamic?: false | undefined;
772
776
  preliminary?: boolean;
773
777
  title?: string;
@@ -781,6 +785,7 @@ type DynamicToolResult = {
781
785
  output: unknown;
782
786
  providerExecuted?: boolean;
783
787
  providerMetadata?: ProviderMetadata;
788
+ toolMetadata?: JSONObject;
784
789
  dynamic: true;
785
790
  preliminary?: boolean;
786
791
  title?: string;
@@ -1697,6 +1702,7 @@ type UIToolInvocation<TOOL extends UITool | Tool> = {
1697
1702
  */
1698
1703
  toolCallId: string;
1699
1704
  title?: string;
1705
+ toolMetadata?: JSONObject;
1700
1706
  /**
1701
1707
  * Whether the tool call was executed by the provider.
1702
1708
  */
@@ -1791,6 +1797,7 @@ type DynamicToolUIPart = {
1791
1797
  */
1792
1798
  toolCallId: string;
1793
1799
  title?: string;
1800
+ toolMetadata?: JSONObject;
1794
1801
  /**
1795
1802
  * Whether the tool call was executed by the provider.
1796
1803
  */
@@ -1950,6 +1957,7 @@ declare const uiMessageChunkSchema: _ai_sdk_provider_utils.LazySchema<{
1950
1957
  toolName: string;
1951
1958
  providerExecuted?: boolean | undefined;
1952
1959
  providerMetadata?: _ai_sdk_provider.SharedV3ProviderMetadata | undefined;
1960
+ toolMetadata?: JSONObject | undefined;
1953
1961
  dynamic?: boolean | undefined;
1954
1962
  title?: string | undefined;
1955
1963
  } | {
@@ -1963,6 +1971,7 @@ declare const uiMessageChunkSchema: _ai_sdk_provider_utils.LazySchema<{
1963
1971
  input: unknown;
1964
1972
  providerExecuted?: boolean | undefined;
1965
1973
  providerMetadata?: _ai_sdk_provider.SharedV3ProviderMetadata | undefined;
1974
+ toolMetadata?: JSONObject | undefined;
1966
1975
  dynamic?: boolean | undefined;
1967
1976
  title?: string | undefined;
1968
1977
  } | {
@@ -1973,6 +1982,7 @@ declare const uiMessageChunkSchema: _ai_sdk_provider_utils.LazySchema<{
1973
1982
  errorText: string;
1974
1983
  providerExecuted?: boolean | undefined;
1975
1984
  providerMetadata?: _ai_sdk_provider.SharedV3ProviderMetadata | undefined;
1985
+ toolMetadata?: JSONObject | undefined;
1976
1986
  dynamic?: boolean | undefined;
1977
1987
  title?: string | undefined;
1978
1988
  } | {
@@ -1985,6 +1995,7 @@ declare const uiMessageChunkSchema: _ai_sdk_provider_utils.LazySchema<{
1985
1995
  output: unknown;
1986
1996
  providerExecuted?: boolean | undefined;
1987
1997
  providerMetadata?: _ai_sdk_provider.SharedV3ProviderMetadata | undefined;
1998
+ toolMetadata?: JSONObject | undefined;
1988
1999
  dynamic?: boolean | undefined;
1989
2000
  preliminary?: boolean | undefined;
1990
2001
  } | {
@@ -1993,6 +2004,7 @@ declare const uiMessageChunkSchema: _ai_sdk_provider_utils.LazySchema<{
1993
2004
  errorText: string;
1994
2005
  providerExecuted?: boolean | undefined;
1995
2006
  providerMetadata?: _ai_sdk_provider.SharedV3ProviderMetadata | undefined;
2007
+ toolMetadata?: JSONObject | undefined;
1996
2008
  dynamic?: boolean | undefined;
1997
2009
  } | {
1998
2010
  type: "tool-output-denied";
@@ -2096,6 +2108,7 @@ type UIMessageChunk<METADATA = unknown, DATA_TYPES extends UIDataTypes = UIDataT
2096
2108
  input: unknown;
2097
2109
  providerExecuted?: boolean;
2098
2110
  providerMetadata?: ProviderMetadata;
2111
+ toolMetadata?: JSONObject;
2099
2112
  dynamic?: boolean;
2100
2113
  title?: string;
2101
2114
  } | {
@@ -2105,6 +2118,7 @@ type UIMessageChunk<METADATA = unknown, DATA_TYPES extends UIDataTypes = UIDataT
2105
2118
  input: unknown;
2106
2119
  providerExecuted?: boolean;
2107
2120
  providerMetadata?: ProviderMetadata;
2121
+ toolMetadata?: JSONObject;
2108
2122
  dynamic?: boolean;
2109
2123
  errorText: string;
2110
2124
  title?: string;
@@ -2118,6 +2132,7 @@ type UIMessageChunk<METADATA = unknown, DATA_TYPES extends UIDataTypes = UIDataT
2118
2132
  output: unknown;
2119
2133
  providerExecuted?: boolean;
2120
2134
  providerMetadata?: ProviderMetadata;
2135
+ toolMetadata?: JSONObject;
2121
2136
  dynamic?: boolean;
2122
2137
  preliminary?: boolean;
2123
2138
  } | {
@@ -2126,6 +2141,7 @@ type UIMessageChunk<METADATA = unknown, DATA_TYPES extends UIDataTypes = UIDataT
2126
2141
  errorText: string;
2127
2142
  providerExecuted?: boolean;
2128
2143
  providerMetadata?: ProviderMetadata;
2144
+ toolMetadata?: JSONObject;
2129
2145
  dynamic?: boolean;
2130
2146
  } | {
2131
2147
  type: 'tool-output-denied';
@@ -2136,6 +2152,7 @@ type UIMessageChunk<METADATA = unknown, DATA_TYPES extends UIDataTypes = UIDataT
2136
2152
  toolName: string;
2137
2153
  providerExecuted?: boolean;
2138
2154
  providerMetadata?: ProviderMetadata;
2155
+ toolMetadata?: JSONObject;
2139
2156
  dynamic?: boolean;
2140
2157
  title?: string;
2141
2158
  } | {
@@ -2533,6 +2550,7 @@ type TextStreamPart<TOOLS extends ToolSet> = {
2533
2550
  id: string;
2534
2551
  toolName: string;
2535
2552
  providerMetadata?: ProviderMetadata;
2553
+ toolMetadata?: JSONObject;
2536
2554
  providerExecuted?: boolean;
2537
2555
  dynamic?: boolean;
2538
2556
  title?: string;
package/dist/index.d.ts CHANGED
@@ -688,6 +688,7 @@ type BaseToolCall = {
688
688
  toolCallId: string;
689
689
  providerExecuted?: boolean;
690
690
  providerMetadata?: ProviderMetadata;
691
+ toolMetadata?: JSONObject;
691
692
  };
692
693
  type StaticToolCall<TOOLS extends ToolSet> = ValueOf<{
693
694
  [NAME in keyof TOOLS]: BaseToolCall & {
@@ -742,6 +743,7 @@ type StaticToolError<TOOLS extends ToolSet> = ValueOf<{
742
743
  error: unknown;
743
744
  providerExecuted?: boolean;
744
745
  providerMetadata?: ProviderMetadata;
746
+ toolMetadata?: JSONObject;
745
747
  dynamic?: false | undefined;
746
748
  title?: string;
747
749
  };
@@ -754,6 +756,7 @@ type DynamicToolError = {
754
756
  error: unknown;
755
757
  providerExecuted?: boolean;
756
758
  providerMetadata?: ProviderMetadata;
759
+ toolMetadata?: JSONObject;
757
760
  dynamic: true;
758
761
  title?: string;
759
762
  };
@@ -768,6 +771,7 @@ type StaticToolResult<TOOLS extends ToolSet> = ValueOf<{
768
771
  output: InferToolOutput<TOOLS[NAME]>;
769
772
  providerExecuted?: boolean;
770
773
  providerMetadata?: ProviderMetadata;
774
+ toolMetadata?: JSONObject;
771
775
  dynamic?: false | undefined;
772
776
  preliminary?: boolean;
773
777
  title?: string;
@@ -781,6 +785,7 @@ type DynamicToolResult = {
781
785
  output: unknown;
782
786
  providerExecuted?: boolean;
783
787
  providerMetadata?: ProviderMetadata;
788
+ toolMetadata?: JSONObject;
784
789
  dynamic: true;
785
790
  preliminary?: boolean;
786
791
  title?: string;
@@ -1697,6 +1702,7 @@ type UIToolInvocation<TOOL extends UITool | Tool> = {
1697
1702
  */
1698
1703
  toolCallId: string;
1699
1704
  title?: string;
1705
+ toolMetadata?: JSONObject;
1700
1706
  /**
1701
1707
  * Whether the tool call was executed by the provider.
1702
1708
  */
@@ -1791,6 +1797,7 @@ type DynamicToolUIPart = {
1791
1797
  */
1792
1798
  toolCallId: string;
1793
1799
  title?: string;
1800
+ toolMetadata?: JSONObject;
1794
1801
  /**
1795
1802
  * Whether the tool call was executed by the provider.
1796
1803
  */
@@ -1950,6 +1957,7 @@ declare const uiMessageChunkSchema: _ai_sdk_provider_utils.LazySchema<{
1950
1957
  toolName: string;
1951
1958
  providerExecuted?: boolean | undefined;
1952
1959
  providerMetadata?: _ai_sdk_provider.SharedV3ProviderMetadata | undefined;
1960
+ toolMetadata?: JSONObject | undefined;
1953
1961
  dynamic?: boolean | undefined;
1954
1962
  title?: string | undefined;
1955
1963
  } | {
@@ -1963,6 +1971,7 @@ declare const uiMessageChunkSchema: _ai_sdk_provider_utils.LazySchema<{
1963
1971
  input: unknown;
1964
1972
  providerExecuted?: boolean | undefined;
1965
1973
  providerMetadata?: _ai_sdk_provider.SharedV3ProviderMetadata | undefined;
1974
+ toolMetadata?: JSONObject | undefined;
1966
1975
  dynamic?: boolean | undefined;
1967
1976
  title?: string | undefined;
1968
1977
  } | {
@@ -1973,6 +1982,7 @@ declare const uiMessageChunkSchema: _ai_sdk_provider_utils.LazySchema<{
1973
1982
  errorText: string;
1974
1983
  providerExecuted?: boolean | undefined;
1975
1984
  providerMetadata?: _ai_sdk_provider.SharedV3ProviderMetadata | undefined;
1985
+ toolMetadata?: JSONObject | undefined;
1976
1986
  dynamic?: boolean | undefined;
1977
1987
  title?: string | undefined;
1978
1988
  } | {
@@ -1985,6 +1995,7 @@ declare const uiMessageChunkSchema: _ai_sdk_provider_utils.LazySchema<{
1985
1995
  output: unknown;
1986
1996
  providerExecuted?: boolean | undefined;
1987
1997
  providerMetadata?: _ai_sdk_provider.SharedV3ProviderMetadata | undefined;
1998
+ toolMetadata?: JSONObject | undefined;
1988
1999
  dynamic?: boolean | undefined;
1989
2000
  preliminary?: boolean | undefined;
1990
2001
  } | {
@@ -1993,6 +2004,7 @@ declare const uiMessageChunkSchema: _ai_sdk_provider_utils.LazySchema<{
1993
2004
  errorText: string;
1994
2005
  providerExecuted?: boolean | undefined;
1995
2006
  providerMetadata?: _ai_sdk_provider.SharedV3ProviderMetadata | undefined;
2007
+ toolMetadata?: JSONObject | undefined;
1996
2008
  dynamic?: boolean | undefined;
1997
2009
  } | {
1998
2010
  type: "tool-output-denied";
@@ -2096,6 +2108,7 @@ type UIMessageChunk<METADATA = unknown, DATA_TYPES extends UIDataTypes = UIDataT
2096
2108
  input: unknown;
2097
2109
  providerExecuted?: boolean;
2098
2110
  providerMetadata?: ProviderMetadata;
2111
+ toolMetadata?: JSONObject;
2099
2112
  dynamic?: boolean;
2100
2113
  title?: string;
2101
2114
  } | {
@@ -2105,6 +2118,7 @@ type UIMessageChunk<METADATA = unknown, DATA_TYPES extends UIDataTypes = UIDataT
2105
2118
  input: unknown;
2106
2119
  providerExecuted?: boolean;
2107
2120
  providerMetadata?: ProviderMetadata;
2121
+ toolMetadata?: JSONObject;
2108
2122
  dynamic?: boolean;
2109
2123
  errorText: string;
2110
2124
  title?: string;
@@ -2118,6 +2132,7 @@ type UIMessageChunk<METADATA = unknown, DATA_TYPES extends UIDataTypes = UIDataT
2118
2132
  output: unknown;
2119
2133
  providerExecuted?: boolean;
2120
2134
  providerMetadata?: ProviderMetadata;
2135
+ toolMetadata?: JSONObject;
2121
2136
  dynamic?: boolean;
2122
2137
  preliminary?: boolean;
2123
2138
  } | {
@@ -2126,6 +2141,7 @@ type UIMessageChunk<METADATA = unknown, DATA_TYPES extends UIDataTypes = UIDataT
2126
2141
  errorText: string;
2127
2142
  providerExecuted?: boolean;
2128
2143
  providerMetadata?: ProviderMetadata;
2144
+ toolMetadata?: JSONObject;
2129
2145
  dynamic?: boolean;
2130
2146
  } | {
2131
2147
  type: 'tool-output-denied';
@@ -2136,6 +2152,7 @@ type UIMessageChunk<METADATA = unknown, DATA_TYPES extends UIDataTypes = UIDataT
2136
2152
  toolName: string;
2137
2153
  providerExecuted?: boolean;
2138
2154
  providerMetadata?: ProviderMetadata;
2155
+ toolMetadata?: JSONObject;
2139
2156
  dynamic?: boolean;
2140
2157
  title?: string;
2141
2158
  } | {
@@ -2533,6 +2550,7 @@ type TextStreamPart<TOOLS extends ToolSet> = {
2533
2550
  id: string;
2534
2551
  toolName: string;
2535
2552
  providerMetadata?: ProviderMetadata;
2553
+ toolMetadata?: JSONObject;
2536
2554
  providerExecuted?: boolean;
2537
2555
  dynamic?: boolean;
2538
2556
  title?: string;