@effect/ai-anthropic 4.0.0-beta.7 → 4.0.0-beta.70

package/dist/AnthropicTool.d.ts

@@ -4,25 +4,27 @@
  * Provides tools that are natively supported by Anthropic's API, including
  * Bash, Code Execution, Computer Use, Memory, and Text Editor functionality.
  *
- * @since 1.0.0
+ * @since 4.0.0
  */
 import * as Schema from "effect/Schema";
 import * as Tool from "effect/unstable/ai/Tool";
 /**
  * Union of all Anthropic provider-defined tools.
  *
- * @since 1.0.0
  * @category models
+ * @since 4.0.0
  */
 export type AnthropicTool = ReturnType<typeof Bash_20241022> | ReturnType<typeof Bash_20250124> | ReturnType<typeof CodeExecution_20250522> | ReturnType<typeof CodeExecution_20250825> | ReturnType<typeof ComputerUse_20241022> | ReturnType<typeof ComputerUse_20250124> | ReturnType<typeof ComputerUse_20251124> | ReturnType<typeof Memory_20250818> | ReturnType<typeof TextEditor_20241022> | ReturnType<typeof TextEditor_20250124> | ReturnType<typeof TextEditor_20250429> | ReturnType<typeof TextEditor_20250728> | ReturnType<typeof ToolSearchRegex_20251119> | ReturnType<typeof ToolSearchBM25_20251119> | ReturnType<typeof WebFetch_20250910> | ReturnType<typeof WebSearch_20250305>;
 /**
  * Anthropic Bash tool (2024-10-22 version).
  *
+ * **Details**
+ *
  * Allows the model to execute bash commands in a sandboxed environment.
  * Requires the "computer-use-2024-10-22" beta header.
  *
- * @since 1.0.0
  * @category Bash
+ * @since 4.0.0
  */
 export declare const Bash_20241022: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
     readonly failureMode?: Mode | undefined;
@@ -39,11 +41,13 @@ export declare const Bash_20241022: <Mode extends Tool.FailureMode | undefined =
 /**
  * Anthropic Bash tool (2025-01-24 version).
  *
+ * **Details**
+ *
  * Allows the model to execute bash commands in a sandboxed environment.
  * Requires the "computer-use-2025-01-24" beta header.
  *
- * @since 1.0.0
  * @category Bash
+ * @since 4.0.0
  */
 export declare const Bash_20250124: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
     readonly failureMode?: Mode | undefined;
@@ -58,10 +62,10 @@ export declare const Bash_20250124: <Mode extends Tool.FailureMode | undefined =
     readonly failureMode: Mode extends undefined ? "error" : Mode;
 }, true>;
 /**
- * Programmatic tool call execution parameter.
+ * Schema for a code execution request that asks Anthropic to run source code as a programmatic tool call.
  *
- * @since 1.0.0
  * @category Code Execution
+ * @since 4.0.0
  */
 export declare const CodeExecutionProgrammaticToolCall: Schema.Struct<{
     readonly type: Schema.Literal<"programmatic-tool-call">;
@@ -71,15 +75,17 @@ export declare const CodeExecutionProgrammaticToolCall: Schema.Struct<{
     readonly code: Schema.String;
 }>;
 /**
- * @since 1.0.0
+ * Input payload for a programmatic code execution tool call, including the source code to execute.
+ *
  * @category Code Execution
+ * @since 4.0.0
  */
 export type CodeExecutionProgrammaticToolCall = typeof CodeExecutionProgrammaticToolCall.Type;
 /**
- * Bash code execution parameter.
+ * Schema for a code execution request that runs a bash command.
  *
- * @since 1.0.0
  * @category Code Execution
+ * @since 4.0.0
  */
 export declare const CodeExecutionBashCommand: Schema.Struct<{
     readonly type: Schema.Literal<"bash_code_execution">;
@@ -89,15 +95,17 @@ export declare const CodeExecutionBashCommand: Schema.Struct<{
     readonly command: Schema.String;
 }>;
 /**
- * @since 1.0.0
+ * Input payload for a bash command executed through Anthropic code execution.
+ *
  * @category Code Execution
+ * @since 4.0.0
  */
 export type CodeExecutionBashCommand = typeof CodeExecutionBashCommand.Type;
 /**
  * Text editor view command for code execution.
  *
- * @since 1.0.0
  * @category Code Execution
+ * @since 4.0.0
  */
 export declare const CodeExecutionTextEditorView: Schema.Struct<{
     readonly type: Schema.Literal<"text_editor_code_execution">;
@@ -108,15 +116,17 @@ export declare const CodeExecutionTextEditorView: Schema.Struct<{
     readonly path: Schema.String;
 }>;
 /**
- * @since 1.0.0
+ * Input payload for viewing a file through the text editor code execution tool.
+ *
  * @category Code Execution
+ * @since 4.0.0
  */
 export type CodeExecutionTextEditorView = typeof CodeExecutionTextEditorView.Type;
 /**
  * Text editor create command for code execution.
  *
- * @since 1.0.0
  * @category Code Execution
+ * @since 4.0.0
  */
 export declare const CodeExecutionTextEditorCreate: Schema.Struct<{
     readonly type: Schema.Literal<"text_editor_code_execution">;
@@ -131,15 +141,17 @@ export declare const CodeExecutionTextEditorCreate: Schema.Struct<{
     readonly file_text: Schema.optional<Schema.NullOr<Schema.String>>;
 }>;
 /**
- * @since 1.0.0
+ * Input payload for creating a file through the text editor code execution tool, optionally including initial file text.
+ *
  * @category Code Execution
+ * @since 4.0.0
  */
 export type CodeExecutionTextEditorCreate = typeof CodeExecutionTextEditorCreate.Type;
 /**
  * Text editor str_replace command for code execution.
  *
- * @since 1.0.0
  * @category Code Execution
+ * @since 4.0.0
  */
 export declare const CodeExecutionTextEditorStrReplace: Schema.Struct<{
     readonly type: Schema.Literal<"text_editor_code_execution">;
@@ -158,15 +170,17 @@ export declare const CodeExecutionTextEditorStrReplace: Schema.Struct<{
     readonly new_str: Schema.String;
 }>;
 /**
- * @since 1.0.0
+ * Input payload for replacing text in a file through the text editor code execution tool.
+ *
  * @category Code Execution
+ * @since 4.0.0
  */
 export type CodeExecutionTextEditorStrReplace = typeof CodeExecutionTextEditorStrReplace.Type;
 /**
- * Simple code execution parameter.
+ * Schema for the 2025-08-25 code execution tool input, containing the code to execute.
  *
- * @since 1.0.0
  * @category Code Execution
+ * @since 4.0.0
  */
 export declare const CodeExecution_20250825_Parameters: Schema.Struct<{
     /**
@@ -175,19 +189,23 @@ export declare const CodeExecution_20250825_Parameters: Schema.Struct<{
     readonly code: Schema.String;
 }>;
 /**
- * @since 1.0.0
+ * Input payload for the 2025-08-25 Anthropic code execution tool.
+ *
  * @category Code Execution
+ * @since 4.0.0
  */
 export type CodeExecution_20250825_Parameters = typeof CodeExecution_20250825_Parameters.Type;
 /**
  * Anthropic Code Execution tool (2025-05-22 version).
  *
+ * **Details**
+ *
  * Allows the model to execute code in a sandboxed environment with support
  * for multiple execution types including programmatic tool calls, bash
  * execution, and text editor operations.
  *
- * @since 1.0.0
  * @category Code Execution
+ * @since 4.0.0
  */
 export declare const CodeExecution_20250522: <Mode extends Tool.FailureMode | undefined = undefined>(args: void) => Tool.ProviderDefined<"anthropic.code_execution_20250522", "AnthropicCodeExecution", {
     readonly args: Schema.Void;
@@ -256,10 +274,12 @@ export declare const CodeExecution_20250522: <Mode extends Tool.FailureMode | un
 /**
  * Anthropic Code Execution tool (2025-08-25 version).
  *
+ * **Details**
+ *
  * Allows the model to execute code in a sandboxed environment.
  *
- * @since 1.0.0
  * @category Code Execution
+ * @since 4.0.0
  */
 export declare const CodeExecution_20250825: <Mode extends Tool.FailureMode | undefined = undefined>(args: void) => Tool.ProviderDefined<"anthropic.code_execution_20250825", "AnthropicCodeExecution", {
     readonly args: Schema.Void;
@@ -321,56 +341,64 @@ export declare const CodeExecution_20250825: <Mode extends Tool.FailureMode | un
 /**
  * An `[x, y]` pixel position.
  *
- * @since 1.0.0
  * @category Computer Use
+ * @since 4.0.0
  */
 export declare const Coordinate: Schema.Tuple<readonly [Schema.Number, Schema.Number]>;
 /**
- * @since 1.0.0
+ * An `[x, y]` screen coordinate in pixels.
+ *
  * @category Computer Use
+ * @since 4.0.0
  */
 export type Coordinate = typeof Coordinate.Type;
 /**
  * A `[x1, y1, x2, y2]` position defining top-left and bottom-right corners.
  *
- * @since 1.0.0
  * @category Computer Use
+ * @since 4.0.0
  */
 export declare const Region: Schema.Tuple<readonly [Schema.Number, Schema.Number, Schema.Number, Schema.Number]>;
 /**
- * @since 1.0.0
+ * An `[x1, y1, x2, y2]` screen region in pixels, from top-left to bottom-right.
+ *
  * @category Computer Use
+ * @since 4.0.0
  */
 export type Region = typeof Region.Type;
 /**
  * The direction of the scroll for scroll actions.
  *
- * @since 1.0.0
  * @category Computer Use
+ * @since 4.0.0
  */
 export declare const ScrollDirection: Schema.Literals<readonly ["up", "down", "left", "right"]>;
 /**
- * @since 1.0.0
+ * Direction used by computer-use scroll actions: `"up"`, `"down"`, `"left"`, or `"right"`.
+ *
  * @category Computer Use
+ * @since 4.0.0
  */
 export type ScrollDirection = typeof ScrollDirection.Type;
 /**
  * Modifier keys that can be held during click/scroll actions.
  *
- * @since 1.0.0
  * @category Computer Use
+ * @since 4.0.0
  */
 export declare const ModifierKey: Schema.Literals<readonly ["alt", "ctrl", "meta", "shift"]>;
 /**
- * @since 1.0.0
+ * Modifier key that can be held during computer-use click or scroll actions.
+ *
  * @category Computer Use
+ * @since 4.0.0
  */
 export type ModifierKey = typeof ModifierKey.Type;
 /**
  * Press a key or key combination (e.g. `"Return"`, `"ctrl+c"`, `"ctrl+s"`).
  *
- * @since 1.0.0
  * @category Computer Use
+ * @since 4.0.0
  */
 export declare const ComputerUseKeyAction: Schema.Struct<{
     readonly action: Schema.Literal<"key">;
@@ -380,15 +408,17 @@ export declare const ComputerUseKeyAction: Schema.Struct<{
     readonly text: Schema.String;
 }>;
 /**
- * @since 1.0.0
+ * Computer-use action payload for pressing a key or key combination.
+ *
  * @category Computer Use
+ * @since 4.0.0
  */
 export type ComputerUseKeyAction = typeof ComputerUseKeyAction.Type;
 /**
  * Perform a left click at the current mouse position or the specified coordinates.
  *
- * @since 1.0.0
  * @category Computer Use
+ * @since 4.0.0
  */
 export declare const ComputerUseLeftClickAction: Schema.Struct<{
     readonly action: Schema.Literal<"left_click">;
@@ -399,15 +429,17 @@ export declare const ComputerUseLeftClickAction: Schema.Struct<{
     readonly coordinate: Schema.optional<Schema.Tuple<readonly [Schema.Number, Schema.Number]>>;
 }>;
 /**
- * @since 1.0.0
+ * Computer-use action payload for performing a left click, optionally at a specific coordinate.
+ *
  * @category Computer Use
+ * @since 4.0.0
  */
 export type ComputerUseLeftClickAction = typeof ComputerUseLeftClickAction.Type;
 /**
  * Move the mouse cursor to the specified coordinates.
  *
- * @since 1.0.0
  * @category Computer Use
+ * @since 4.0.0
  */
 export declare const ComputerUseMouseMoveAction: Schema.Struct<{
     readonly action: Schema.Literal<"mouse_move">;
@@ -417,29 +449,33 @@ export declare const ComputerUseMouseMoveAction: Schema.Struct<{
     readonly coordinate: Schema.Tuple<readonly [Schema.Number, Schema.Number]>;
 }>;
 /**
- * @since 1.0.0
+ * Computer-use action payload for moving the mouse cursor to a specific coordinate.
+ *
  * @category Computer Use
+ * @since 4.0.0
  */
 export type ComputerUseMouseMoveAction = typeof ComputerUseMouseMoveAction.Type;
 /**
  * Capture the current display.
  *
- * @since 1.0.0
  * @category Computer Use
+ * @since 4.0.0
  */
 export declare const ComputerUseScreenshotAction: Schema.Struct<{
     readonly action: Schema.Literal<"screenshot">;
 }>;
 /**
- * @since 1.0.0
+ * Computer-use action payload for capturing the current display.
+ *
  * @category Computer Use
+ * @since 4.0.0
  */
 export type ComputerUseScreenshotAction = typeof ComputerUseScreenshotAction.Type;
 /**
  * Type a text string.
  *
- * @since 1.0.0
  * @category Computer Use
+ * @since 4.0.0
  */
 export declare const TypeAction: Schema.Struct<{
     readonly action: Schema.Literal<"type">;
@@ -449,15 +485,17 @@ export declare const TypeAction: Schema.Struct<{
     readonly text: Schema.String;
 }>;
 /**
- * @since 1.0.0
+ * Computer-use action payload for typing a text string.
+ *
  * @category Computer Use
+ * @since 4.0.0
  */
 export type TypeAction = typeof TypeAction.Type;
 /**
  * Perform a double click.
  *
- * @since 1.0.0
  * @category Computer Use
+ * @since 4.0.0
  */
 export declare const ComputerUseDoubleClickAction: Schema.Struct<{
     readonly action: Schema.Literal<"double_click">;
@@ -468,15 +506,17 @@ export declare const ComputerUseDoubleClickAction: Schema.Struct<{
     readonly coordinate: Schema.optional<Schema.Tuple<readonly [Schema.Number, Schema.Number]>>;
 }>;
 /**
- * @since 1.0.0
+ * Computer-use action payload for performing a double click, optionally at a specific coordinate.
+ *
  * @category Computer Use
+ * @since 4.0.0
  */
 export type ComputerUseDoubleClickAction = typeof ComputerUseDoubleClickAction.Type;
 /**
- * Holds a key while performing other actions.
+ * Hold a key for a specified duration during computer-use execution.
  *
- * @since 1.0.0
  * @category Computer Use
+ * @since 4.0.0
  */
 export declare const ComputerUseHoldKeyAction: Schema.Struct<{
     readonly action: Schema.Literal<"hold_key">;
@@ -490,15 +530,17 @@ export declare const ComputerUseHoldKeyAction: Schema.Struct<{
     readonly duration: Schema.Number;
 }>;
 /**
- * @since 1.0.0
+ * Computer-use action payload for holding a key for a specified duration.
+ *
  * @category Computer Use
+ * @since 4.0.0
  */
 export type ComputerUseHoldKeyAction = typeof ComputerUseHoldKeyAction.Type;
 /**
  * Click and drag from start coordinate to end coordinate.
  *
- * @since 1.0.0
  * @category Computer Use
+ * @since 4.0.0
  */
 export declare const ComputerUseLeftClickDragAction: Schema.Struct<{
     readonly action: Schema.Literal<"left_click_drag">;
@@ -512,17 +554,21 @@ export declare const ComputerUseLeftClickDragAction: Schema.Struct<{
     readonly coordinate: Schema.Tuple<readonly [Schema.Number, Schema.Number]>;
 }>;
 /**
- * @since 1.0.0
+ * Computer-use action payload for dragging from a start coordinate to an end coordinate.
+ *
  * @category Computer Use
+ * @since 4.0.0
  */
 export type ComputerUseLeftClickDragAction = typeof ComputerUseLeftClickDragAction.Type;
 /**
  * Press the left mouse button down (without releasing).
  *
- * Used for fine-grained click control.
+ * **When to use**
+ *
+ * Use this for fine-grained click control.
  *
- * @since 1.0.0
  * @category Computer Use
+ * @since 4.0.0
  */
 export declare const ComputerUseLeftMouseDownAction: Schema.Struct<{
     readonly action: Schema.Literal<"left_mouse_down">;
@@ -533,17 +579,21 @@ export declare const ComputerUseLeftMouseDownAction: Schema.Struct<{
     readonly coordinate: Schema.optional<Schema.Tuple<readonly [Schema.Number, Schema.Number]>>;
 }>;
 /**
- * @since 1.0.0
+ * Computer-use action payload for pressing and holding the left mouse button, optionally at a specific coordinate.
+ *
  * @category Computer Use
+ * @since 4.0.0
  */
 export type ComputerUseLeftMouseDownAction = typeof ComputerUseLeftMouseDownAction.Type;
 /**
  * Release the left mouse button.
  *
- * Used for fine-grained click control.
+ * **When to use**
+ *
+ * Use this for fine-grained click control.
  *
- * @since 1.0.0
  * @category Computer Use
+ * @since 4.0.0
  */
 export declare const ComputerUseLeftMouseUpAction: Schema.Struct<{
     readonly action: Schema.Literal<"left_mouse_up">;
@@ -554,15 +604,17 @@ export declare const ComputerUseLeftMouseUpAction: Schema.Struct<{
     readonly coordinate: Schema.optional<Schema.Tuple<readonly [Schema.Number, Schema.Number]>>;
 }>;
 /**
- * @since 1.0.0
+ * Computer-use action payload for releasing the left mouse button, optionally at a specific coordinate.
+ *
  * @category Computer Use
+ * @since 4.0.0
  */
 export type ComputerUseLeftMouseUpAction = typeof ComputerUseLeftMouseUpAction.Type;
 /**
  * Perform a middle click.
  *
- * @since 1.0.0
  * @category Computer Use
+ * @since 4.0.0
  */
 export declare const ComputerUseMiddleClickAction: Schema.Struct<{
     readonly action: Schema.Literal<"middle_click">;
@@ -573,15 +625,17 @@ export declare const ComputerUseMiddleClickAction: Schema.Struct<{
     readonly coordinate: Schema.optional<Schema.Tuple<readonly [Schema.Number, Schema.Number]>>;
 }>;
 /**
- * @since 1.0.0
+ * Computer-use action payload for performing a middle click, optionally at a specific coordinate.
+ *
  * @category Computer Use
+ * @since 4.0.0
  */
 export type ComputerUseMiddleClickAction = typeof ComputerUseMiddleClickAction.Type;
 /**
  * Perform a right click.
  *
- * @since 1.0.0
  * @category Computer Use
+ * @since 4.0.0
  */
 export declare const ComputerUseRightClickAction: Schema.Struct<{
     readonly action: Schema.Literal<"right_click">;
@@ -592,15 +646,17 @@ export declare const ComputerUseRightClickAction: Schema.Struct<{
     readonly coordinate: Schema.optional<Schema.Tuple<readonly [Schema.Number, Schema.Number]>>;
 }>;
 /**
- * @since 1.0.0
+ * Computer-use action payload for performing a right click, optionally at a specific coordinate.
+ *
  * @category Computer Use
+ * @since 4.0.0
  */
 export type ComputerUseRightClickAction = typeof ComputerUseRightClickAction.Type;
 /**
  * Scroll a given amount in a specified direction.
  *
- * @since 1.0.0
  * @category Computer Use
+ * @since 4.0.0
  */
 export declare const ComputerUseScrollAction: Schema.Struct<{
     readonly action: Schema.Literal<"scroll">;
@@ -619,15 +675,17 @@ export declare const ComputerUseScrollAction: Schema.Struct<{
     readonly scroll_amount: Schema.Number;
 }>;
 /**
- * @since 1.0.0
+ * Computer-use action payload for scrolling by a specified amount in a specified direction, optionally from a coordinate.
+ *
  * @category Computer Use
+ * @since 4.0.0
  */
 export type ComputerUseScrollAction = typeof ComputerUseScrollAction.Type;
 /**
  * Perform a triple click.
  *
- * @since 1.0.0
  * @category Computer Use
+ * @since 4.0.0
  */
 export declare const ComputerUseTripleClickAction: Schema.Struct<{
     readonly action: Schema.Literal<"triple_click">;
@@ -638,15 +696,17 @@ export declare const ComputerUseTripleClickAction: Schema.Struct<{
     readonly coordinate: Schema.optional<Schema.Tuple<readonly [Schema.Number, Schema.Number]>>;
 }>;
 /**
- * @since 1.0.0
+ * Computer-use action payload for performing a triple click, optionally at a specific coordinate.
+ *
  * @category Computer Use
+ * @since 4.0.0
  */
 export type ComputerUseTripleClickAction = typeof ComputerUseTripleClickAction.Type;
 /**
  * Pause between performing actions.
  *
- * @since 1.0.0
  * @category Computer Use
+ * @since 4.0.0
  */
 export declare const ComputerUseWaitAction: Schema.Struct<{
     readonly action: Schema.Literal<"wait">;
@@ -656,17 +716,21 @@ export declare const ComputerUseWaitAction: Schema.Struct<{
     readonly duration: Schema.Number;
 }>;
 /**
- * @since 1.0.0
+ * Computer-use action payload for pausing for a specified duration.
+ *
  * @category Computer Use
+ * @since 4.0.0
  */
 export type ComputerUseWaitAction = typeof ComputerUseWaitAction.Type;
 /**
  * Zoom into a specific region of the screen at full resolution.
  *
+ * **Details**
+ *
  * Requires `enableZoom: true` in the tool definition.
  *
- * @since 1.0.0
  * @category Computer Use
+ * @since 4.0.0
  */
 export declare const ComputerUseZoomAction: Schema.Struct<{
     readonly action: Schema.Literal<"zoom">;
@@ -677,19 +741,26 @@ export declare const ComputerUseZoomAction: Schema.Struct<{
     readonly region: Schema.Tuple<readonly [Schema.Number, Schema.Number, Schema.Number, Schema.Number]>;
 }>;
 /**
- * @since 1.0.0
+ * Computer-use action payload for zooming into a specific screen region.
+ *
+ * **Details**
+ *
+ * The enclosing computer-use tool must be configured with `enableZoom: true`.
+ *
  * @category Computer Use
+ * @since 4.0.0
  */
 export type ComputerUseZoomAction = typeof ComputerUseZoomAction.Type;
 /**
  * Computer use tool for Claude 3.5 Sonnet v2 (deprecated).
  *
- * Requires the "computer-use-2024-10-22" beta header.
+ * **Details**
  *
+ * Requires the "computer-use-2024-10-22" beta header.
  * Basic actions only: screenshot, left_click, type, key, mouse_move.
  *
- * @since 1.0.0
  * @category Computer Use
+ * @since 4.0.0
  */
 export declare const ComputerUse_20241022: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
     readonly displayWidthPx: number;
@@ -748,14 +819,15 @@ export declare const ComputerUse_20241022: <Mode extends Tool.FailureMode | unde
 /**
  * Computer use tool for Claude 4 models and Claude Sonnet 3.7.
  *
- * Requires the "computer-use-2025-01-24" beta header.
+ * **Details**
  *
+ * Requires the "computer-use-2025-01-24" beta header.
  * Includes basic actions plus enhanced actions: scroll, left_click_drag,
  * right_click, middle_click, double_click, triple_click, left_mouse_down,
  * left_mouse_up, hold_key, wait.
  *
- * @since 1.0.0
  * @category Computer Use
+ * @since 4.0.0
  */
 export declare const ComputerUse_20250124: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
     readonly displayWidthPx: number;
@@ -897,19 +969,20 @@ export declare const ComputerUse_20250124: <Mode extends Tool.FailureMode | unde
 /**
  * Computer use tool for Claude Opus 4.5 only.
  *
- * Requires the "computer-use-2025-11-24" beta header.
+ * **Details**
  *
+ * Requires the "computer-use-2025-11-24" beta header.
  * Includes all actions from computer_20250124 plus the zoom action for
  * detailed screen region inspection. Requires `enableZoom: true` in args.
  *
- * @since 1.0.0
  * @category Computer Use
+ * @since 4.0.0
  */
 export declare const ComputerUse_20251124: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
     readonly displayWidthPx: number;
     readonly displayHeightPx: number;
-    readonly displayNumber?: number | undefined;
     readonly enableZoom?: boolean | undefined;
+    readonly displayNumber?: number | undefined;
     readonly failureMode?: Mode | undefined;
 }) => Tool.ProviderDefined<"anthropic.computer_20251124", "AnthropicComputerUse", {
     readonly args: Schema.Struct<{
@@ -1054,25 +1127,28 @@ export declare const ComputerUse_20251124: <Mode extends Tool.FailureMode | unde
 /**
  * A `[start, end]` line range for viewing file contents.
  *
- * Lines are 1-indexed. Use -1 for end to read to end of file.
+ * **Details**
  *
- * @example [1, 50]    // View lines 1-50
- * @example [100, -1]  // View from line 100 to end of file
+ * Lines are 1-indexed. Use -1 for end to read to the end of the file. For
+ * example, `[1, 50]` views lines 1-50 and `[100, -1]` views from line 100 to
+ * the end of the file.
  *
- * @since 1.0.0
  * @category Memory
+ * @since 4.0.0
  */
 export declare const ViewRange: Schema.Tuple<readonly [Schema.Number, Schema.Number]>;
 /**
- * @since 1.0.0
+ * A `[start, end]` 1-indexed line range for viewing file contents, using `-1` as the end value to read through the end of the file.
+ *
  * @category Memory
+ * @since 4.0.0
  */
 export type ViewRange = typeof ViewRange.Type;
 /**
  * Creates a new file.
  *
- * @since 1.0.0
  * @category Memory
+ * @since 4.0.0
  */
 export declare const MemoryCreateCommand: Schema.Struct<{
     readonly command: Schema.Literal<"create">;
@@ -1082,15 +1158,17 @@ export declare const MemoryCreateCommand: Schema.Struct<{
     readonly path: Schema.String;
 }>;
 /**
- * @since 1.0.0
+ * Memory tool command payload for creating a new file at a path.
+ *
  * @category Memory
+ * @since 4.0.0
  */
 export type MemoryCreateCommand = typeof MemoryCreateCommand.Type;
 /**
  * Delete a file or directory.
  *
- * @since 1.0.0
  * @category Memory
+ * @since 4.0.0
  */
 export declare const MemoryDeleteCommand: Schema.Struct<{
     readonly command: Schema.Literal<"delete">;
@@ -1100,15 +1178,17 @@ export declare const MemoryDeleteCommand: Schema.Struct<{
     readonly path: Schema.String;
 }>;
 /**
- * @since 1.0.0
+ * Memory tool command payload for deleting a file or directory at a path.
+ *
  * @category Memory
+ * @since 4.0.0
  */
 export type MemoryDeleteCommand = typeof MemoryDeleteCommand.Type;
 /**
  * Insert text at a specific line.
  *
- * @since 1.0.0
  * @category Memory
+ * @since 4.0.0
  */
 export declare const MemoryInsertCommand: Schema.Struct<{
     readonly command: Schema.Literal<"insert">;
@@ -1126,15 +1206,17 @@ export declare const MemoryInsertCommand: Schema.Struct<{
     readonly insert_text: Schema.String;
 }>;
 /**
- * @since 1.0.0
+ * Memory tool command payload for inserting text at a specific line in a file.
+ *
  * @category Memory
+ * @since 4.0.0
  */
 export type MemoryInsertCommand = typeof MemoryInsertCommand.Type;
 /**
  * Rename or move a file or directory.
  *
- * @since 1.0.0
  * @category Memory
+ * @since 4.0.0
  */
 export declare const MemoryRenameCommand: Schema.Struct<{
     readonly command: Schema.Literal<"rename">;
@@ -1148,15 +1230,17 @@ export declare const MemoryRenameCommand: Schema.Struct<{
     readonly new_path: Schema.String;
 }>;
 /**
- * @since 1.0.0
+ * Memory tool command payload for renaming or moving a file or directory.
+ *
  * @category Memory
+ * @since 4.0.0
  */
 export type MemoryRenameCommand = typeof MemoryRenameCommand.Type;
 /**
  * Replace text in a file.
  *
- * @since 1.0.0
  * @category Memory
+ * @since 4.0.0
  */
 export declare const MemoryStrReplaceCommand: Schema.Struct<{
     readonly command: Schema.Literal<"str_replace">;
@@ -1174,15 +1258,17 @@ export declare const MemoryStrReplaceCommand: Schema.Struct<{
     readonly new_str: Schema.String;
 }>;
 /**
- * @since 1.0.0
+ * Memory tool command payload for replacing text in a file.
+ *
  * @category Memory
+ * @since 4.0.0
  */
 export type MemoryStrReplaceCommand = typeof MemoryStrReplaceCommand.Type;
 /**
  * Shows directory contents or file contents with optional line ranges.
  *
- * @since 1.0.0
  * @category Memory
+ * @since 4.0.0
  */
 export declare const MemoryViewCommand: Schema.Struct<{
     readonly command: Schema.Literal<"view">;
@@ -1196,18 +1282,22 @@ export declare const MemoryViewCommand: Schema.Struct<{
     readonly view_range: Schema.optional<Schema.Tuple<readonly [Schema.Number, Schema.Number]>>;
 }>;
 /**
- * @since 1.0.0
+ * Memory tool command payload for viewing a file or directory, optionally with a file line range.
+ *
  * @category Memory
+ * @since 4.0.0
  */
 export type MemoryViewCommand = typeof MemoryViewCommand.Type;
 /**
  * Memory tool for persistent file operations across conversations.
  *
+ * **Details**
+ *
  * Provides commands for creating, viewing, editing, renaming, and deleting
  * files within the model's memory space.
  *
- * @since 1.0.0
  * @category Memory
+ * @since 4.0.0
  */
 export declare const Memory_20250818: <Mode extends Tool.FailureMode | undefined = undefined>(args: void) => Tool.ProviderDefined<"anthropic.memory_20250818", "AnthropicMemory", {
     readonly args: Schema.Void;
@@ -1279,11 +1369,13 @@ export declare const Memory_20250818: <Mode extends Tool.FailureMode | undefined
 /**
  * View the contents of a file or list directory contents.
  *
- * When used on a file: Returns the file contents, optionally limited to a line range.
- * When used on a directory: Lists all files and subdirectories.
+ * **Details**
+ *
+ * When used on a file, returns the file contents, optionally limited to a line
+ * range. When used on a directory, lists all files and subdirectories.
  *
- * @since 1.0.0
  * @category Text Editor
+ * @since 4.0.0
  */
 export declare const TextEditorViewCommand: Schema.Struct<{
     readonly command: Schema.Literal<"view">;
@@ -1298,17 +1390,21 @@ export declare const TextEditorViewCommand: Schema.Struct<{
     readonly view_range: Schema.optional<Schema.Tuple<readonly [Schema.Number, Schema.Number]>>;
 }>;
 /**
- * @since 1.0.0
+ * Text editor command payload for viewing file contents or listing directory contents.
+ *
  * @category Text Editor
+ * @since 4.0.0
  */
 export type TextEditorViewCommand = typeof TextEditorViewCommand.Type;
 /**
  * Create a new file with specified content.
  *
- * Will fail if the file already exists. Parent directories must exist.
+ * **Gotchas**
+ *
+ * Fails if the file already exists. Parent directories must exist.
  *
- * @since 1.0.0
  * @category Text Editor
+ * @since 4.0.0
  */
 export declare const TextEditorCreateCommand: Schema.Struct<{
     readonly command: Schema.Literal<"create">;
@@ -1322,18 +1418,26 @@ export declare const TextEditorCreateCommand: Schema.Struct<{
     readonly file_text: Schema.String;
 }>;
 /**
- * @since 1.0.0
+ * Text editor command payload for creating a new file with the specified content.
+ *
+ * **Gotchas**
+ *
+ * The command fails if the file already exists or if parent directories are missing.
+ *
  * @category Text Editor
+ * @since 4.0.0
  */
 export type TextEditorCreateCommand = typeof TextEditorCreateCommand.Type;
 /**
  * Replace a specific string in a file with a new string.
  *
+ * **Gotchas**
+ *
  * The `old_str` must match exactly (including whitespace and indentation)
  * and must be unique in the file.
  *
- * @since 1.0.0
  * @category Text Editor
+ * @since 4.0.0
  */
 export declare const TextEditorStrReplaceCommand: Schema.Struct<{
     readonly command: Schema.Literal<"str_replace">;
@@ -1351,17 +1455,21 @@ export declare const TextEditorStrReplaceCommand: Schema.Struct<{
     readonly new_str: Schema.String;
 }>;
 /**
- * @since 1.0.0
+ * Text editor command payload for replacing one exact, unique string in a file.
+ *
  * @category Text Editor
+ * @since 4.0.0
  */
 export type TextEditorStrReplaceCommand = typeof TextEditorStrReplaceCommand.Type;
 /**
  * Insert text at a specific line number in a file.
  *
+ * **Details**
+ *
  * Inserts the new text AFTER the specified line number.
  *
- * @since 1.0.0
  * @category Text Editor
+ * @since 4.0.0
  */
 export declare const TextEditorInsertCommand: Schema.Struct<{
     readonly command: Schema.Literal<"insert">;
@@ -1379,20 +1487,26 @@ export declare const TextEditorInsertCommand: Schema.Struct<{
     readonly new_str: Schema.String;
 }>;
 /**
- * @since 1.0.0
+ * Text editor command payload for inserting text after a specific line number in a file.
+ *
  * @category Text Editor
+ * @since 4.0.0
  */
 export type TextEditorInsertCommand = typeof TextEditorInsertCommand.Type;
 /**
  * Undo the last edit made to a file.
  *
+ * **Details**
+ *
  * Reverts the most recent str_replace, insert, or create operation on the file.
  *
- * NOTE: This command is available in text_editor_20241022 and text_editor_20250124,
- * but NOT in text_editor_20250728 (Claude 4 models).
+ * **Gotchas**
+ *
+ * This command is available in text_editor_20241022 and text_editor_20250124,
+ * but not in text_editor_20250728 (Claude 4 models).
  *
- * @since 1.0.0
  * @category Text Editor
+ * @since 4.0.0
  */
 export declare const TextEditorUndoEditCommand: Schema.Struct<{
     readonly command: Schema.Literal<"undo_edit">;
@@ -1402,17 +1516,25 @@ export declare const TextEditorUndoEditCommand: Schema.Struct<{
     readonly path: Schema.String;
 }>;
 /**
- * @since 1.0.0
+ * Text editor command payload for undoing the most recent edit to a file.
+ *
+ * **Gotchas**
+ *
+ * Available for `text_editor_20241022` and `text_editor_20250124`, but not for Claude 4 text editor versions.
+ *
  * @category Text Editor
+ * @since 4.0.0
  */
 export type TextEditorUndoEditCommand = typeof TextEditorUndoEditCommand.Type;
 /**
  * Text editor tool for Claude 3.5 Sonnet (deprecated).
  *
+ * **Details**
+ *
  * Requires the "computer-use-2024-10-22" beta header.
  *
- * @since 1.0.0
  * @category Text Editor
+ * @since 4.0.0
  */
 export declare const TextEditor_20241022: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
     readonly failureMode?: Mode | undefined;
@@ -1481,8 +1603,12 @@ export declare const TextEditor_20241022: <Mode extends Tool.FailureMode | undef
 /**
  * Text editor tool for Claude Sonnet 3.7 (deprecated model).
  *
- * @since 1.0.0
+ * **Details**
+ *
+ * Requires the "computer-use-2025-01-24" beta header.
+ *
  * @category Text Editor
+ * @since 4.0.0
  */
 export declare const TextEditor_20250124: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
     readonly failureMode?: Mode | undefined;
@@ -1549,12 +1675,18 @@ export declare const TextEditor_20250124: <Mode extends Tool.FailureMode | undef
     readonly failureMode: Mode extends undefined ? "error" : Mode;
 }, true>;
 /**
- * Text editor tool for Claude 4 models.
+ * Text editor tool for Claude 4 models using Anthropic's `str_replace_based_edit_tool`.
  *
- * NOTE: This version does NOT support the `undo_edit` command.
+ * **Details**
+ *
+ * Requires the "computer-use-2025-01-24" beta header.
+ *
+ * **Gotchas**
+ *
+ * This version does not support the `undo_edit` command.
  *
- * @since 1.0.0
  * @category Text Editor
+ * @since 4.0.0
  */
 export declare const TextEditor_20250429: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
     readonly max_characters?: number | undefined;
@@ -1624,10 +1756,12 @@ export declare const TextEditor_20250429: <Mode extends Tool.FailureMode | undef
 /**
  * Text editor tool for Claude 4 models.
  *
- * NOTE: This version does NOT support the `undo_edit` command.
+ * **Gotchas**
+ *
+ * This version does not support the `undo_edit` command.
  *
- * @since 1.0.0
  * @category Text Editor
+ * @since 4.0.0
  */
 export declare const TextEditor_20250728: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
     readonly max_characters?: number | undefined;
@@ -1697,11 +1831,13 @@ export declare const TextEditor_20250728: <Mode extends Tool.FailureMode | undef
 /**
  * User location for localizing search results.
  *
+ * **When to use**
+ *
  * Providing location helps return more relevant results for location-dependent
  * queries like weather, local businesses, events, etc.
  *
- * @since 1.0.0
  * @category Web Search
+ * @since 4.0.0
  */
 export declare const WebSearchUserLocation: Schema.Struct<{
     /**
@@ -1728,8 +1864,8 @@ export declare const WebSearchUserLocation: Schema.Struct<{
 /**
  * Configuration arguments for the web search tool.
  *
- * @since 1.0.0
  * @category Web Search
+ * @since 4.0.0
  */
 export declare const WebSearch_20250305_Args: Schema.Struct<{
     /**
@@ -1775,15 +1911,17 @@ export declare const WebSearch_20250305_Args: Schema.Struct<{
     }>>;
 }>;
 /**
- * @since 1.0.0
+ * Configuration arguments for the Anthropic web search tool, including usage limits, domain filters, and optional user location.
+ *
  * @category Web Search
+ * @since 4.0.0
  */
 export type WebSearch_20250305_Args = typeof WebSearch_20250305_Args.Type;
 /**
  * Input parameters for a web search.
  *
- * @since 1.0.0
  * @category Web Search
+ * @since 4.0.0
  */
 export declare const WebSearchParameters: Schema.Struct<{
     /**
@@ -1792,20 +1930,27 @@ export declare const WebSearchParameters: Schema.Struct<{
     readonly query: Schema.String;
 }>;
 /**
- * @since 1.0.0
+ * Type of the parameters Claude supplies when invoking the Anthropic web search tool.
+ *
+ * **Details**
+ *
+ * Contains the generated search query used by `WebSearch_20250305`.
+ *
  * @category Web Search
+ * @since 4.0.0
  */
 export type WebSearchParameters = typeof WebSearchParameters.Type;
 /**
  * Web search tool for Claude models.
  *
+ * **Details**
+ *
  * Enables Claude to search the web for real-time information. This is a
  * server-side tool executed by Anthropic's infrastructure.
- *
  * Generally available (no beta header required).
  *
- * @since 1.0.0
  * @category Web Search
+ * @since 4.0.0
  */
 export declare const WebSearch_20250305: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
     readonly maxUses?: number | undefined;
@@ -1814,8 +1959,8 @@ export declare const WebSearch_20250305: <Mode extends Tool.FailureMode | undefi
     readonly userLocation?: {
         readonly type: "approximate";
         readonly city?: string | undefined;
-        readonly country?: string | undefined;
         readonly region?: string | undefined;
+        readonly country?: string | undefined;
         readonly timezone?: string | undefined;
     } | undefined;
 }) => Tool.ProviderDefined<"anthropic.web_search_20250305", "AnthropicWebSearch", {
@@ -1884,8 +2029,8 @@ export declare const WebSearch_20250305: <Mode extends Tool.FailureMode | undefi
 /**
  * Citation configuration for web fetch.
  *
- * @since 1.0.0
  * @category Web Fetch
+ * @since 4.0.0
  */
 export declare const WebFetchCitationsConfig: Schema.Struct<{
     /**
@@ -1894,15 +2039,17 @@ export declare const WebFetchCitationsConfig: Schema.Struct<{
     readonly enabled: Schema.Boolean;
 }>;
 /**
- * @since 1.0.0
+ * Configuration payload for enabling or disabling citations on web fetch results.
+ *
  * @category Web Fetch
+ * @since 4.0.0
  */
 export type WebFetchCitationsConfig = typeof WebFetchCitationsConfig.Type;
 /**
  * Configuration arguments for the web fetch tool.
  *
- * @since 1.0.0
  * @category Web Fetch
+ * @since 4.0.0
  */
 export declare const WebFetch_20250910_Args: Schema.Struct<{
     /**
@@ -1936,15 +2083,17 @@ export declare const WebFetch_20250910_Args: Schema.Struct<{
     readonly maxContentTokens: Schema.optional<Schema.Number>;
 }>;
 /**
- * @since 1.0.0
+ * Configuration arguments for the Anthropic web fetch tool, including usage limits, domain filters, citation settings, and token limits.
+ *
  * @category Web Fetch
+ * @since 4.0.0
  */
 export type WebFetch_20250910_Args = typeof WebFetch_20250910_Args.Type;
 /**
  * Input parameters for a web fetch.
  *
- * @since 1.0.0
  * @category Web Fetch
+ * @since 4.0.0
  */
 export declare const WebFetchParameters: Schema.Struct<{
     /**
@@ -1954,28 +2103,31 @@ export declare const WebFetchParameters: Schema.Struct<{
     readonly url: Schema.String;
 }>;
 /**
- * @since 1.0.0
+ * Type of the parameters Claude supplies when invoking the Anthropic web fetch tool.
+ *
  * @category Web Fetch
+ * @since 4.0.0
  */
 export type WebFetchParameters = typeof WebFetchParameters.Type;
 /**
  * Web fetch tool for Claude models.
  *
+ * **Details**
+ *
  * Allows Claude to retrieve full content from web pages and PDF documents.
  * This is a server-side tool executed by Anthropic's infrastructure.
- *
  * Requires the "web-fetch-2025-09-10" beta header.
  *
- * @since 1.0.0
  * @category Web Fetch
+ * @since 4.0.0
  */
 export declare const WebFetch_20250910: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
-    readonly citations?: {
-        readonly enabled: boolean;
-    } | undefined;
     readonly maxUses?: number | undefined;
     readonly allowedDomains?: readonly string[] | undefined;
     readonly blockedDomains?: readonly string[] | undefined;
+    readonly citations?: {
+        readonly enabled: boolean;
+    } | undefined;
     readonly maxContentTokens?: number | undefined;
 }) => Tool.ProviderDefined<"anthropic.web_fetch_20250910", "AnthropicWebFetch", {
     readonly args: Schema.Struct<{
@@ -2046,11 +2198,13 @@ export declare const WebFetch_20250910: <Mode extends Tool.FailureMode | undefin
 /**
  * Input parameters for regex-based tool search.
  *
+ * **Details**
+ *
  * Claude constructs regex patterns using Python's `re.search()` syntax.
  * Maximum query length: 200 characters.
  *
- * @since 1.0.0
  * @category Tool Search
+ * @since 4.0.0
  */
 export declare const ToolSearchRegexParameters: Schema.Struct<{
     /**
@@ -2059,15 +2213,17 @@ export declare const ToolSearchRegexParameters: Schema.Struct<{
     readonly query: Schema.String;
 }>;
 /**
- * @since 1.0.0
+ * Type of the parameters Claude supplies when invoking regex-based Anthropic tool search.
+ *
  * @category Tool Search
+ * @since 4.0.0
  */
 export type ToolSearchRegexParameters = typeof ToolSearchRegexParameters.Type;
 /**
  * Input parameters for BM25/natural language tool search.
  *
- * @since 1.0.0
  * @category Tool Search
+ * @since 4.0.0
  */
 export declare const ToolSearchBM25Parameters: Schema.Struct<{
     /**
@@ -2076,21 +2232,24 @@ export declare const ToolSearchBM25Parameters: Schema.Struct<{
     readonly query: Schema.String;
 }>;
 /**
- * @since 1.0.0
+ * Type of the parameters Claude supplies when invoking BM25 natural-language Anthropic tool search.
+ *
  * @category Tool Search
+ * @since 4.0.0
  */
 export type ToolSearchBM25Parameters = typeof ToolSearchBM25Parameters.Type;
 /**
  * Regex-based tool search for Claude models.
  *
+ * **Details**
+ *
  * Claude constructs regex patterns using Python's `re.search()` syntax to
  * find tools. The regex is matched against tool names, descriptions,
  * argument names, and argument descriptions.
- *
  * Requires the "advanced-tool-use-2025-11-20" beta header.
  *
- * @since 1.0.0
  * @category Tool Search
+ * @since 4.0.0
  */
 export declare const ToolSearchRegex_20251119: <Mode extends Tool.FailureMode | undefined = undefined>(args: void) => Tool.ProviderDefined<"anthropic.tool_search_tool_regex_20251119", "AnthropicToolSearchRegex", {
     readonly args: Schema.Void;
@@ -2118,14 +2277,15 @@ export declare const ToolSearchRegex_20251119: <Mode extends Tool.FailureMode |
 /**
  * BM25/natural language tool search for Claude models.
  *
+ * **Details**
+ *
  * Claude uses natural language queries to search for tools using the
  * BM25 algorithm. The search is performed against tool names, descriptions,
  * argument names, and argument descriptions.
- *
  * Requires the "advanced-tool-use-2025-11-20" beta header.
  *
- * @since 1.0.0
  * @category Tool Search
+ * @since 4.0.0
  */
 export declare const ToolSearchBM25_20251119: <Mode extends Tool.FailureMode | undefined = undefined>(args: void) => Tool.ProviderDefined<"anthropic.tool_search_tool_bm25_20251119", "AnthropicToolSearchBM25", {
     readonly args: Schema.Void;