@ai-sdk/anthropic 2.0.13 → 2.0.14

package/CHANGELOG.md

@@ -1,5 +1,11 @@
 # @ai-sdk/anthropic
 
+## 2.0.14
+
+### Patch Changes
+
+- 2338c79: feat (provider/anthropic): update jsdoc of anthropic tools
+
 ## 2.0.13
 
 ### Patch Changes

package/dist/index.d.mts

@@ -16,69 +16,62 @@ type AnthropicProviderOptions = z.infer<typeof anthropicProviderOptions>;
 
 declare const anthropicTools: {
     /**
-     * Creates a tool for running a bash command. Must have name "bash".
+     * The bash tool enables Claude to execute shell commands in a persistent bash session,
+     * allowing system operations, script execution, and command-line automation.
      *
      * Image results are supported.
      *
-     * @param execute - The function to execute the tool. Optional.
+     * Tool name must be `bash`.
      */
     bash_20241022: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{
         command: string;
         restart?: boolean;
     }, {}>;
     /**
-     * Creates a tool for running a bash command. Must have name "bash".
+     * The bash tool enables Claude to execute shell commands in a persistent bash session,
+     * allowing system operations, script execution, and command-line automation.
      *
      * Image results are supported.
      *
-     * @param execute - The function to execute the tool. Optional.
+     * Tool name must be `bash`.
      */
     bash_20250124: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{
         command: string;
         restart?: boolean;
     }, {}>;
     /**
-     * Creates a tool for editing text. Must have name "str_replace_editor".
-     */
-    textEditor_20241022: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{
-        command: "view" | "create" | "str_replace" | "insert" | "undo_edit";
-        path: string;
-        file_text?: string;
-        insert_line?: number;
-        new_str?: string;
-        old_str?: string;
-        view_range?: number[];
-    }, {}>;
-    /**
-     * Creates a tool for editing text. Must have name "str_replace_editor".
-     */
-    textEditor_20250124: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{
-        command: "view" | "create" | "str_replace" | "insert" | "undo_edit";
-        path: string;
-        file_text?: string;
-        insert_line?: number;
-        new_str?: string;
-        old_str?: string;
-        view_range?: number[];
-    }, {}>;
-    /**
-     * Creates a tool for editing text. Must have name "str_replace_based_edit_tool".
-     * Note: This version does not support the "undo_edit" command.
+     * Claude can analyze data, create visualizations, perform complex calculations,
+     * run system commands, create and edit files, and process uploaded files directly within
+     * the API conversation.
+     *
+     * The code execution tool allows Claude to run Bash commands and manipulate files,
+     * including writing code, in a secure, sandboxed environment.
+     *
+     * Tool name must be `code_execution`.
      */
-    textEditor_20250429: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{
-        command: "view" | "create" | "str_replace" | "insert";
-        path: string;
-        file_text?: string;
-        insert_line?: number;
-        new_str?: string;
-        old_str?: string;
-        view_range?: number[];
-    }, {}>;
+    codeExecution_20250522: (args?: Parameters<_ai_sdk_provider_utils.ProviderDefinedToolFactoryWithOutputSchema<{
+        code: string;
+    }, {
+        type: "code_execution_result";
+        stdout: string;
+        stderr: string;
+        return_code: number;
+    }, {}>>[0]) => _ai_sdk_provider_utils.Tool<{
+        code: string;
+    }, {
+        type: "code_execution_result";
+        stdout: string;
+        stderr: string;
+        return_code: number;
+    }>;
     /**
-     * Creates a tool for executing actions on a computer. Must have name "computer".
+     * Claude can interact with computer environments through the computer use tool, which
+     * provides screenshot capabilities and mouse/keyboard control for autonomous desktop interaction.
      *
      * Image results are supported.
      *
+     * Tool name must be `computer`.
+     *
      * @param displayWidthPx - The width of the display being controlled by the model in pixels.
      * @param displayHeightPx - The height of the display being controlled by the model in pixels.
      * @param displayNumber - The display number to control (only relevant for X11 environments). If specified, the tool will be provided a display number in the tool definition.
@@ -93,14 +86,16 @@ declare const anthropicTools: {
         displayNumber?: number;
     }>;
     /**
-     * Creates a tool for executing actions on a computer. Must have name "computer".
+     * Claude can interact with computer environments through the computer use tool, which
+     * provides screenshot capabilities and mouse/keyboard control for autonomous desktop interaction.
      *
      * Image results are supported.
      *
+     * Tool name must be `computer`.
+     *
      * @param displayWidthPx - The width of the display being controlled by the model in pixels.
      * @param displayHeightPx - The height of the display being controlled by the model in pixels.
      * @param displayNumber - The display number to control (only relevant for X11 environments). If specified, the tool will be provided a display number in the tool definition.
-     * @param execute - The function to execute the tool. Optional.
      */
     computer_20250124: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{
         action: "key" | "hold_key" | "type" | "cursor_position" | "mouse_move" | "left_mouse_down" | "left_mouse_up" | "left_click" | "left_click_drag" | "right_click" | "middle_click" | "double_click" | "triple_click" | "scroll" | "wait" | "screenshot";
@@ -115,9 +110,60 @@ declare const anthropicTools: {
         displayHeightPx: number;
         displayNumber?: number;
     }>;
+    /**
+     * Claude can use an Anthropic-defined text editor tool to view and modify text files,
+     * helping you debug, fix, and improve your code or other text documents. This allows Claude
+     * to directly interact with your files, providing hands-on assistance rather than just suggesting changes.
+     *
+     * Tool name must be `str_replace_editor`.
+     */
+    textEditor_20241022: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{
+        command: "view" | "create" | "str_replace" | "insert" | "undo_edit";
+        path: string;
+        file_text?: string;
+        insert_line?: number;
+        new_str?: string;
+        old_str?: string;
+        view_range?: number[];
+    }, {}>;
+    /**
+     * Claude can use an Anthropic-defined text editor tool to view and modify text files,
+     * helping you debug, fix, and improve your code or other text documents. This allows Claude
+     * to directly interact with your files, providing hands-on assistance rather than just suggesting changes.
+     *
+     * Tool name must be `str_replace_editor`.
+     */
+    textEditor_20250124: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{
+        command: "view" | "create" | "str_replace" | "insert" | "undo_edit";
+        path: string;
+        file_text?: string;
+        insert_line?: number;
+        new_str?: string;
+        old_str?: string;
+        view_range?: number[];
+    }, {}>;
+    /**
+     * Claude can use an Anthropic-defined text editor tool to view and modify text files,
+     * helping you debug, fix, and improve your code or other text documents. This allows Claude
+     * to directly interact with your files, providing hands-on assistance rather than just suggesting changes.
+     *
+     * Note: This version does not support the "undo_edit" command.
+     *
+     * Tool name must be `str_replace_based_edit_tool`.
+     */
+    textEditor_20250429: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{
+        command: "view" | "create" | "str_replace" | "insert";
+        path: string;
+        file_text?: string;
+        insert_line?: number;
+        new_str?: string;
+        old_str?: string;
+        view_range?: number[];
+    }, {}>;
     /**
      * Creates a web search tool that gives Claude direct access to real-time web content.
-     * Must have name "web_search".
+     *
+     * Tool name must be `web_search`.
      *
      * @param maxUses - Maximum number of web searches Claude can perform during the conversation.
      * @param allowedDomains - Optional list of domains that Claude is allowed to search.
@@ -152,24 +198,6 @@ declare const anthropicTools: {
         encryptedContent: string;
         type: string;
     }[]>;
-    /**
-     * Creates a tool for executing Python code. Must have name "code_execution".
-     */
-    codeExecution_20250522: (args?: Parameters<_ai_sdk_provider_utils.ProviderDefinedToolFactoryWithOutputSchema<{
-        code: string;
-    }, {
-        type: "code_execution_result";
-        stdout: string;
-        stderr: string;
-        return_code: number;
-    }, {}>>[0]) => _ai_sdk_provider_utils.Tool<{
-        code: string;
-    }, {
-        type: "code_execution_result";
-        stdout: string;
-        stderr: string;
-        return_code: number;
-    }>;
 };
 
 interface AnthropicProvider extends ProviderV2 {

package/dist/index.d.ts

@@ -16,69 +16,62 @@ type AnthropicProviderOptions = z.infer<typeof anthropicProviderOptions>;
 
 declare const anthropicTools: {
     /**
-     * Creates a tool for running a bash command. Must have name "bash".
+     * The bash tool enables Claude to execute shell commands in a persistent bash session,
+     * allowing system operations, script execution, and command-line automation.
      *
      * Image results are supported.
      *
-     * @param execute - The function to execute the tool. Optional.
+     * Tool name must be `bash`.
      */
     bash_20241022: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{
         command: string;
         restart?: boolean;
     }, {}>;
     /**
-     * Creates a tool for running a bash command. Must have name "bash".
+     * The bash tool enables Claude to execute shell commands in a persistent bash session,
+     * allowing system operations, script execution, and command-line automation.
      *
      * Image results are supported.
      *
-     * @param execute - The function to execute the tool. Optional.
+     * Tool name must be `bash`.
      */
     bash_20250124: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{
         command: string;
         restart?: boolean;
     }, {}>;
     /**
-     * Creates a tool for editing text. Must have name "str_replace_editor".
-     */
-    textEditor_20241022: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{
-        command: "view" | "create" | "str_replace" | "insert" | "undo_edit";
-        path: string;
-        file_text?: string;
-        insert_line?: number;
-        new_str?: string;
-        old_str?: string;
-        view_range?: number[];
-    }, {}>;
-    /**
-     * Creates a tool for editing text. Must have name "str_replace_editor".
-     */
-    textEditor_20250124: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{
-        command: "view" | "create" | "str_replace" | "insert" | "undo_edit";
-        path: string;
-        file_text?: string;
-        insert_line?: number;
-        new_str?: string;
-        old_str?: string;
-        view_range?: number[];
-    }, {}>;
-    /**
-     * Creates a tool for editing text. Must have name "str_replace_based_edit_tool".
-     * Note: This version does not support the "undo_edit" command.
+     * Claude can analyze data, create visualizations, perform complex calculations,
+     * run system commands, create and edit files, and process uploaded files directly within
+     * the API conversation.
+     *
+     * The code execution tool allows Claude to run Bash commands and manipulate files,
+     * including writing code, in a secure, sandboxed environment.
+     *
+     * Tool name must be `code_execution`.
      */
-    textEditor_20250429: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{
-        command: "view" | "create" | "str_replace" | "insert";
-        path: string;
-        file_text?: string;
-        insert_line?: number;
-        new_str?: string;
-        old_str?: string;
-        view_range?: number[];
-    }, {}>;
+    codeExecution_20250522: (args?: Parameters<_ai_sdk_provider_utils.ProviderDefinedToolFactoryWithOutputSchema<{
+        code: string;
+    }, {
+        type: "code_execution_result";
+        stdout: string;
+        stderr: string;
+        return_code: number;
+    }, {}>>[0]) => _ai_sdk_provider_utils.Tool<{
+        code: string;
+    }, {
+        type: "code_execution_result";
+        stdout: string;
+        stderr: string;
+        return_code: number;
+    }>;
     /**
-     * Creates a tool for executing actions on a computer. Must have name "computer".
+     * Claude can interact with computer environments through the computer use tool, which
+     * provides screenshot capabilities and mouse/keyboard control for autonomous desktop interaction.
      *
      * Image results are supported.
      *
+     * Tool name must be `computer`.
+     *
      * @param displayWidthPx - The width of the display being controlled by the model in pixels.
      * @param displayHeightPx - The height of the display being controlled by the model in pixels.
      * @param displayNumber - The display number to control (only relevant for X11 environments). If specified, the tool will be provided a display number in the tool definition.
@@ -93,14 +86,16 @@ declare const anthropicTools: {
         displayNumber?: number;
     }>;
     /**
-     * Creates a tool for executing actions on a computer. Must have name "computer".
+     * Claude can interact with computer environments through the computer use tool, which
+     * provides screenshot capabilities and mouse/keyboard control for autonomous desktop interaction.
      *
      * Image results are supported.
      *
+     * Tool name must be `computer`.
+     *
      * @param displayWidthPx - The width of the display being controlled by the model in pixels.
      * @param displayHeightPx - The height of the display being controlled by the model in pixels.
      * @param displayNumber - The display number to control (only relevant for X11 environments). If specified, the tool will be provided a display number in the tool definition.
-     * @param execute - The function to execute the tool. Optional.
      */
     computer_20250124: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{
         action: "key" | "hold_key" | "type" | "cursor_position" | "mouse_move" | "left_mouse_down" | "left_mouse_up" | "left_click" | "left_click_drag" | "right_click" | "middle_click" | "double_click" | "triple_click" | "scroll" | "wait" | "screenshot";
@@ -115,9 +110,60 @@ declare const anthropicTools: {
         displayHeightPx: number;
         displayNumber?: number;
     }>;
+    /**
+     * Claude can use an Anthropic-defined text editor tool to view and modify text files,
+     * helping you debug, fix, and improve your code or other text documents. This allows Claude
+     * to directly interact with your files, providing hands-on assistance rather than just suggesting changes.
+     *
+     * Tool name must be `str_replace_editor`.
+     */
+    textEditor_20241022: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{
+        command: "view" | "create" | "str_replace" | "insert" | "undo_edit";
+        path: string;
+        file_text?: string;
+        insert_line?: number;
+        new_str?: string;
+        old_str?: string;
+        view_range?: number[];
+    }, {}>;
+    /**
+     * Claude can use an Anthropic-defined text editor tool to view and modify text files,
+     * helping you debug, fix, and improve your code or other text documents. This allows Claude
+     * to directly interact with your files, providing hands-on assistance rather than just suggesting changes.
+     *
+     * Tool name must be `str_replace_editor`.
+     */
+    textEditor_20250124: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{
+        command: "view" | "create" | "str_replace" | "insert" | "undo_edit";
+        path: string;
+        file_text?: string;
+        insert_line?: number;
+        new_str?: string;
+        old_str?: string;
+        view_range?: number[];
+    }, {}>;
+    /**
+     * Claude can use an Anthropic-defined text editor tool to view and modify text files,
+     * helping you debug, fix, and improve your code or other text documents. This allows Claude
+     * to directly interact with your files, providing hands-on assistance rather than just suggesting changes.
+     *
+     * Note: This version does not support the "undo_edit" command.
+     *
+     * Tool name must be `str_replace_based_edit_tool`.
+     */
+    textEditor_20250429: _ai_sdk_provider_utils.ProviderDefinedToolFactory<{
+        command: "view" | "create" | "str_replace" | "insert";
+        path: string;
+        file_text?: string;
+        insert_line?: number;
+        new_str?: string;
+        old_str?: string;
+        view_range?: number[];
+    }, {}>;
     /**
      * Creates a web search tool that gives Claude direct access to real-time web content.
-     * Must have name "web_search".
+     *
+     * Tool name must be `web_search`.
      *
      * @param maxUses - Maximum number of web searches Claude can perform during the conversation.
      * @param allowedDomains - Optional list of domains that Claude is allowed to search.
@@ -152,24 +198,6 @@ declare const anthropicTools: {
         encryptedContent: string;
         type: string;
     }[]>;
-    /**
-     * Creates a tool for executing Python code. Must have name "code_execution".
-     */
-    codeExecution_20250522: (args?: Parameters<_ai_sdk_provider_utils.ProviderDefinedToolFactoryWithOutputSchema<{
-        code: string;
-    }, {
-        type: "code_execution_result";
-        stdout: string;
-        stderr: string;
-        return_code: number;
-    }, {}>>[0]) => _ai_sdk_provider_utils.Tool<{
-        code: string;
-    }, {
-        type: "code_execution_result";
-        stdout: string;
-        stderr: string;
-        return_code: number;
-    }>;
 };
 
 interface AnthropicProvider extends ProviderV2 {

package/dist/index.js

@@ -2004,69 +2004,97 @@ var textEditor_20250429 = (0, import_provider_utils12.createProviderDefinedToolF
 // src/anthropic-tools.ts
 var anthropicTools = {
   /**
-   * Creates a tool for running a bash command. Must have name "bash".
+   * The bash tool enables Claude to execute shell commands in a persistent bash session,
+   * allowing system operations, script execution, and command-line automation.
    *
    * Image results are supported.
    *
-   * @param execute - The function to execute the tool. Optional.
+   * Tool name must be `bash`.
    */
   bash_20241022,
   /**
-   * Creates a tool for running a bash command. Must have name "bash".
+   * The bash tool enables Claude to execute shell commands in a persistent bash session,
+   * allowing system operations, script execution, and command-line automation.
    *
    * Image results are supported.
    *
-   * @param execute - The function to execute the tool. Optional.
+   * Tool name must be `bash`.
    */
   bash_20250124,
   /**
-   * Creates a tool for editing text. Must have name "str_replace_editor".
-   */
-  textEditor_20241022,
-  /**
-   * Creates a tool for editing text. Must have name "str_replace_editor".
-   */
-  textEditor_20250124,
-  /**
-   * Creates a tool for editing text. Must have name "str_replace_based_edit_tool".
-   * Note: This version does not support the "undo_edit" command.
+   * Claude can analyze data, create visualizations, perform complex calculations,
+   * run system commands, create and edit files, and process uploaded files directly within
+   * the API conversation.
+   *
+   * The code execution tool allows Claude to run Bash commands and manipulate files,
+   * including writing code, in a secure, sandboxed environment.
+   *
+   * Tool name must be `code_execution`.
    */
-  textEditor_20250429,
+  codeExecution_20250522,
   /**
-   * Creates a tool for executing actions on a computer. Must have name "computer".
+   * Claude can interact with computer environments through the computer use tool, which
+   * provides screenshot capabilities and mouse/keyboard control for autonomous desktop interaction.
    *
    * Image results are supported.
    *
+   * Tool name must be `computer`.
+   *
    * @param displayWidthPx - The width of the display being controlled by the model in pixels.
    * @param displayHeightPx - The height of the display being controlled by the model in pixels.
    * @param displayNumber - The display number to control (only relevant for X11 environments). If specified, the tool will be provided a display number in the tool definition.
    */
   computer_20241022,
   /**
-   * Creates a tool for executing actions on a computer. Must have name "computer".
+   * Claude can interact with computer environments through the computer use tool, which
+   * provides screenshot capabilities and mouse/keyboard control for autonomous desktop interaction.
    *
    * Image results are supported.
    *
+   * Tool name must be `computer`.
+   *
    * @param displayWidthPx - The width of the display being controlled by the model in pixels.
    * @param displayHeightPx - The height of the display being controlled by the model in pixels.
    * @param displayNumber - The display number to control (only relevant for X11 environments). If specified, the tool will be provided a display number in the tool definition.
-   * @param execute - The function to execute the tool. Optional.
    */
   computer_20250124,
+  /**
+   * Claude can use an Anthropic-defined text editor tool to view and modify text files,
+   * helping you debug, fix, and improve your code or other text documents. This allows Claude
+   * to directly interact with your files, providing hands-on assistance rather than just suggesting changes.
+   *
+   * Tool name must be `str_replace_editor`.
+   */
+  textEditor_20241022,
+  /**
+   * Claude can use an Anthropic-defined text editor tool to view and modify text files,
+   * helping you debug, fix, and improve your code or other text documents. This allows Claude
+   * to directly interact with your files, providing hands-on assistance rather than just suggesting changes.
+   *
+   * Tool name must be `str_replace_editor`.
+   */
+  textEditor_20250124,
+  /**
+   * Claude can use an Anthropic-defined text editor tool to view and modify text files,
+   * helping you debug, fix, and improve your code or other text documents. This allows Claude
+   * to directly interact with your files, providing hands-on assistance rather than just suggesting changes.
+   *
+   * Note: This version does not support the "undo_edit" command.
+   *
+   * Tool name must be `str_replace_based_edit_tool`.
+   */
+  textEditor_20250429,
   /**
    * Creates a web search tool that gives Claude direct access to real-time web content.
-   * Must have name "web_search".
+   *
+   * Tool name must be `web_search`.
    *
    * @param maxUses - Maximum number of web searches Claude can perform during the conversation.
    * @param allowedDomains - Optional list of domains that Claude is allowed to search.
    * @param blockedDomains - Optional list of domains that Claude should avoid when searching.
    * @param userLocation - Optional user location information to provide geographically relevant search results.
    */
-  webSearch_20250305,
-  /**
-   * Creates a tool for executing Python code. Must have name "code_execution".
-   */
-  codeExecution_20250522
+  webSearch_20250305
 };
 
 // src/anthropic-provider.ts