@effect/ai-anthropic 4.0.0-beta.71 → 4.0.0-beta.73

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.
@@ -77,7 +77,7 @@ import * as Tool from "effect/unstable/ai/Tool";
77
77
  */
78
78
  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>;
79
79
  /**
80
- * Anthropic Bash tool (2024-10-22 version).
80
+ * Defines the Anthropic Bash tool (2024-10-22 version).
81
81
  *
82
82
  * **When to use**
83
83
  *
@@ -107,7 +107,7 @@ export declare const Bash_20241022: <Mode extends Tool.FailureMode | undefined =
107
107
  readonly failureMode: Mode extends undefined ? "error" : Mode;
108
108
  }, true>;
109
109
  /**
110
- * Anthropic Bash tool (2025-01-24 version).
110
+ * Defines the Anthropic Bash tool (2025-01-24 version).
111
111
  *
112
112
  * **When to use**
113
113
  *
@@ -385,7 +385,7 @@ export declare const CodeExecution_20250825_Parameters: Schema.Struct<{
385
385
  */
386
386
  export type CodeExecution_20250825_Parameters = typeof CodeExecution_20250825_Parameters.Type;
387
387
  /**
388
- * Anthropic Code Execution tool (2025-05-22 version).
388
+ * Defines the Anthropic Code Execution tool (2025-05-22 version).
389
389
  *
390
390
  * **When to use**
391
391
  *
@@ -468,7 +468,7 @@ export declare const CodeExecution_20250522: <Mode extends Tool.FailureMode | un
468
468
  readonly failureMode: Mode extends undefined ? "error" : Mode;
469
469
  }, false>;
470
470
  /**
471
- * Anthropic Code Execution tool (2025-08-25 version).
471
+ * Defines the Anthropic Code Execution tool (2025-08-25 version).
472
472
  *
473
473
  * **When to use**
474
474
  *
@@ -555,14 +555,14 @@ export declare const CodeExecution_20250825: <Mode extends Tool.FailureMode | un
555
555
  *
556
556
  * This schema validates tuple shape only and does not check display bounds.
557
557
  *
558
- * @category Computer Use
558
+ * @category computer use
559
559
  * @since 4.0.0
560
560
  */
561
561
  export declare const Coordinate: Schema.Tuple<readonly [Schema.Number, Schema.Number]>;
562
562
  /**
563
563
  * An `[x, y]` screen coordinate in pixels.
564
564
  *
565
- * @category Computer Use
565
+ * @category computer use
566
566
  * @since 4.0.0
567
567
  */
568
568
  export type Coordinate = typeof Coordinate.Type;
@@ -578,52 +578,52 @@ export type Coordinate = typeof Coordinate.Type;
578
578
  * This schema validates four numbers only and does not check coordinate ordering
579
579
  * or display bounds.
580
580
  *
581
- * @category Computer Use
581
+ * @category computer use
582
582
  * @since 4.0.0
583
583
  */
584
584
  export declare const Region: Schema.Tuple<readonly [Schema.Number, Schema.Number, Schema.Number, Schema.Number]>;
585
585
  /**
586
586
  * An `[x1, y1, x2, y2]` screen region in pixels, from top-left to bottom-right.
587
587
  *
588
- * @category Computer Use
588
+ * @category computer use
589
589
  * @since 4.0.0
590
590
  */
591
591
  export type Region = typeof Region.Type;
592
592
  /**
593
- * Scroll direction literal: `"up"`, `"down"`, `"left"`, or `"right"`.
593
+ * Schema for scroll direction literals: `"up"`, `"down"`, `"left"`, or `"right"`.
594
594
  *
595
595
  * @see {@link ComputerUseScrollAction} for the action payload that consumes this schema
596
596
  *
597
- * @category Computer Use
597
+ * @category computer use
598
598
  * @since 4.0.0
599
599
  */
600
600
  export declare const ScrollDirection: Schema.Literals<readonly ["up", "down", "left", "right"]>;
601
601
  /**
602
602
  * Direction used by computer-use scroll actions: `"up"`, `"down"`, `"left"`, or `"right"`.
603
603
  *
604
- * @category Computer Use
604
+ * @category computer use
605
605
  * @since 4.0.0
606
606
  */
607
607
  export type ScrollDirection = typeof ScrollDirection.Type;
608
608
  /**
609
- * Modifier key literal.
609
+ * Schema for modifier key literals.
610
610
  *
611
611
  * **Details**
612
612
  *
613
613
  * Allowed values are `"alt"`, `"ctrl"`, `"meta"`, and `"shift"`.
614
614
  *
615
- * @category Computer Use
615
+ * @category computer use
616
616
  * @since 4.0.0
617
617
  */
618
618
  export declare const ModifierKey: Schema.Literals<readonly ["alt", "ctrl", "meta", "shift"]>;
619
619
  /**
620
- * Modifier key literal.
620
+ * Modifier key literals.
621
621
  *
622
622
  * **Details**
623
623
  *
624
624
  * Allowed values are `"alt"`, `"ctrl"`, `"meta"`, and `"shift"`.
625
625
  *
626
- * @category Computer Use
626
+ * @category computer use
627
627
  * @since 4.0.0
628
628
  */
629
629
  export type ModifierKey = typeof ModifierKey.Type;
@@ -639,7 +639,7 @@ export type ModifierKey = typeof ModifierKey.Type;
639
639
  * @see {@link TypeAction} for entering ordinary text strings
640
640
  * @see {@link ComputerUseHoldKeyAction} for holding a key for a duration
641
641
  *
642
- * @category Computer Use
642
+ * @category computer use
643
643
  * @since 4.0.0
644
644
  */
645
645
  export declare const ComputerUseKeyAction: Schema.Struct<{
@@ -662,7 +662,7 @@ export declare const ComputerUseKeyAction: Schema.Struct<{
662
662
  * `text` is typed as `string`; the paired schema does not validate
663
663
  * provider-specific key names or key combinations.
664
664
  *
665
- * @category Computer Use
665
+ * @category computer use
666
666
  * @since 4.0.0
667
667
  */
668
668
  export type ComputerUseKeyAction = typeof ComputerUseKeyAction.Type;
@@ -689,7 +689,7 @@ export type ComputerUseKeyAction = typeof ComputerUseKeyAction.Type;
689
689
  * @see {@link ComputerUseDoubleClickAction} for performing a double click
690
690
  * @see {@link ComputerUseMouseMoveAction} for moving the mouse without clicking
691
691
  *
692
- * @category Computer Use
692
+ * @category computer use
693
693
  * @since 4.0.0
694
694
  */
695
695
  export declare const ComputerUseLeftClickAction: Schema.Struct<{
@@ -703,7 +703,7 @@ export declare const ComputerUseLeftClickAction: Schema.Struct<{
703
703
  /**
704
704
  * Computer-use action payload for performing a left click, optionally at a specific coordinate.
705
705
  *
706
- * @category Computer Use
706
+ * @category computer use
707
707
  * @since 4.0.0
708
708
  */
709
709
  export type ComputerUseLeftClickAction = typeof ComputerUseLeftClickAction.Type;
@@ -727,7 +727,7 @@ export type ComputerUseLeftClickAction = typeof ComputerUseLeftClickAction.Type;
727
727
  * does not validate that the point falls within the configured display
728
728
  * dimensions.
729
729
  *
730
- * @category Computer Use
730
+ * @category computer use
731
731
  * @since 4.0.0
732
732
  */
733
733
  export declare const ComputerUseMouseMoveAction: Schema.Struct<{
@@ -740,7 +740,7 @@ export declare const ComputerUseMouseMoveAction: Schema.Struct<{
740
740
  /**
741
741
  * Computer-use action payload for moving the mouse cursor to a specific coordinate.
742
742
  *
743
- * @category Computer Use
743
+ * @category computer use
744
744
  * @since 4.0.0
745
745
  */
746
746
  export type ComputerUseMouseMoveAction = typeof ComputerUseMouseMoveAction.Type;
@@ -759,7 +759,7 @@ export type ComputerUseMouseMoveAction = typeof ComputerUseMouseMoveAction.Type;
759
759
  *
760
760
  * @see {@link ComputerUseZoomAction} for requesting a zoomed-in screenshot of a specific screen region with the 2025-11-24 computer-use tool
761
761
  *
762
- * @category Computer Use
762
+ * @category computer use
763
763
  * @since 4.0.0
764
764
  */
765
765
  export declare const ComputerUseScreenshotAction: Schema.Struct<{
@@ -768,7 +768,7 @@ export declare const ComputerUseScreenshotAction: Schema.Struct<{
768
768
  /**
769
769
  * Computer-use action payload for capturing the current display.
770
770
  *
771
- * @category Computer Use
771
+ * @category computer use
772
772
  * @since 4.0.0
773
773
  */
774
774
  export type ComputerUseScreenshotAction = typeof ComputerUseScreenshotAction.Type;
@@ -787,7 +787,7 @@ export type ComputerUseScreenshotAction = typeof ComputerUseScreenshotAction.Typ
787
787
  *
788
788
  * @see {@link ComputerUseKeyAction} for key presses and keyboard shortcuts
789
789
  *
790
- * @category Computer Use
790
+ * @category computer use
791
791
  * @since 4.0.0
792
792
  */
793
793
  export declare const TypeAction: Schema.Struct<{
@@ -805,7 +805,7 @@ export declare const TypeAction: Schema.Struct<{
805
805
  * The payload uses `action: "type"` and a `text` string containing the text to
806
806
  * enter.
807
807
  *
808
- * @category Computer Use
808
+ * @category computer use
809
809
  * @since 4.0.0
810
810
  */
811
811
  export type TypeAction = typeof TypeAction.Type;
@@ -831,7 +831,7 @@ export type TypeAction = typeof TypeAction.Type;
831
831
  *
832
832
  * @see {@link ComputerUseLeftClickAction} for performing a single left click
833
833
  *
834
- * @category Computer Use
834
+ * @category computer use
835
835
  * @since 4.0.0
836
836
  */
837
837
  export declare const ComputerUseDoubleClickAction: Schema.Struct<{
@@ -845,12 +845,12 @@ export declare const ComputerUseDoubleClickAction: Schema.Struct<{
845
845
  /**
846
846
  * Computer-use action payload for performing a double click, optionally at a specific coordinate.
847
847
  *
848
- * @category Computer Use
848
+ * @category computer use
849
849
  * @since 4.0.0
850
850
  */
851
851
  export type ComputerUseDoubleClickAction = typeof ComputerUseDoubleClickAction.Type;
852
852
  /**
853
- * Hold a key for a specified duration during computer-use execution.
853
+ * Keeps a key pressed for a specified duration during computer-use execution.
854
854
  *
855
855
  * **When to use**
856
856
  *
@@ -871,7 +871,7 @@ export type ComputerUseDoubleClickAction = typeof ComputerUseDoubleClickAction.T
871
871
  * @see {@link ComputerUseKeyAction} for pressing a key or key combination without holding it
872
872
  * @see {@link ComputerUseWaitAction} for pausing between actions without holding a key
873
873
  *
874
- * @category Computer Use
874
+ * @category computer use
875
875
  * @since 4.0.0
876
876
  */
877
877
  export declare const ComputerUseHoldKeyAction: Schema.Struct<{
@@ -899,7 +899,7 @@ export declare const ComputerUseHoldKeyAction: Schema.Struct<{
899
899
  *
900
900
  * @see {@link ComputerUseKeyAction} for a single key press or key combination without a hold duration
901
901
  *
902
- * @category Computer Use
902
+ * @category computer use
903
903
  * @since 4.0.0
904
904
  */
905
905
  export type ComputerUseHoldKeyAction = typeof ComputerUseHoldKeyAction.Type;
@@ -925,7 +925,7 @@ export type ComputerUseHoldKeyAction = typeof ComputerUseHoldKeyAction.Type;
925
925
  * @see {@link ComputerUseLeftMouseDownAction} for starting a manual drag sequence
926
926
  * @see {@link ComputerUseLeftMouseUpAction} for ending a manual drag sequence
927
927
  *
928
- * @category Computer Use
928
+ * @category computer use
929
929
  * @since 4.0.0
930
930
  */
931
931
  export declare const ComputerUseLeftClickDragAction: Schema.Struct<{
@@ -942,18 +942,19 @@ export declare const ComputerUseLeftClickDragAction: Schema.Struct<{
942
942
  /**
943
943
  * Computer-use action payload for dragging from a start coordinate to an end coordinate.
944
944
  *
945
- * @category Computer Use
945
+ * @category computer use
946
946
  * @since 4.0.0
947
947
  */
948
948
  export type ComputerUseLeftClickDragAction = typeof ComputerUseLeftClickDragAction.Type;
949
949
  /**
950
- * Press the left mouse button down (without releasing).
950
+ * Starts a left mouse button press without releasing it.
951
951
  *
952
952
  * **When to use**
953
953
  *
954
- * Use when you use this for fine-grained click control.
954
+ * Use when constructing a manual click or drag sequence that should press and
955
+ * hold the left mouse button before a later release.
955
956
  *
956
- * @category Computer Use
957
+ * @category computer use
957
958
  * @since 4.0.0
958
959
  */
959
960
  export declare const ComputerUseLeftMouseDownAction: Schema.Struct<{
@@ -967,18 +968,19 @@ export declare const ComputerUseLeftMouseDownAction: Schema.Struct<{
967
968
  /**
968
969
  * Computer-use action payload for pressing and holding the left mouse button, optionally at a specific coordinate.
969
970
  *
970
- * @category Computer Use
971
+ * @category computer use
971
972
  * @since 4.0.0
972
973
  */
973
974
  export type ComputerUseLeftMouseDownAction = typeof ComputerUseLeftMouseDownAction.Type;
974
975
  /**
975
- * Release the left mouse button.
976
+ * Releases the left mouse button.
976
977
  *
977
978
  * **When to use**
978
979
  *
979
- * Use when you use this for fine-grained click control.
980
+ * Use when constructing a manual click or drag sequence that should release the
981
+ * left mouse button after it was previously held down.
980
982
  *
981
- * @category Computer Use
983
+ * @category computer use
982
984
  * @since 4.0.0
983
985
  */
984
986
  export declare const ComputerUseLeftMouseUpAction: Schema.Struct<{
@@ -992,7 +994,7 @@ export declare const ComputerUseLeftMouseUpAction: Schema.Struct<{
992
994
  /**
993
995
  * Computer-use action payload for releasing the left mouse button, optionally at a specific coordinate.
994
996
  *
995
- * @category Computer Use
997
+ * @category computer use
996
998
  * @since 4.0.0
997
999
  */
998
1000
  export type ComputerUseLeftMouseUpAction = typeof ComputerUseLeftMouseUpAction.Type;
@@ -1018,7 +1020,7 @@ export type ComputerUseLeftMouseUpAction = typeof ComputerUseLeftMouseUpAction.T
1018
1020
  * @see {@link ComputerUseLeftClickAction} for primary-button clicks
1019
1021
  * @see {@link ComputerUseRightClickAction} for secondary-button clicks
1020
1022
  *
1021
- * @category Computer Use
1023
+ * @category computer use
1022
1024
  * @since 4.0.0
1023
1025
  */
1024
1026
  export declare const ComputerUseMiddleClickAction: Schema.Struct<{
@@ -1032,7 +1034,7 @@ export declare const ComputerUseMiddleClickAction: Schema.Struct<{
1032
1034
  /**
1033
1035
  * Computer-use action payload for performing a middle click, optionally at a specific coordinate.
1034
1036
  *
1035
- * @category Computer Use
1037
+ * @category computer use
1036
1038
  * @since 4.0.0
1037
1039
  */
1038
1040
  export type ComputerUseMiddleClickAction = typeof ComputerUseMiddleClickAction.Type;
@@ -1054,7 +1056,7 @@ export type ComputerUseMiddleClickAction = typeof ComputerUseMiddleClickAction.T
1054
1056
  * @see {@link ComputerUseLeftClickAction} for the corresponding left-click action
1055
1057
  * @see {@link ComputerUseMiddleClickAction} for the corresponding middle-click action
1056
1058
  *
1057
- * @category Computer Use
1059
+ * @category computer use
1058
1060
  * @since 4.0.0
1059
1061
  */
1060
1062
  export declare const ComputerUseRightClickAction: Schema.Struct<{
@@ -1068,7 +1070,7 @@ export declare const ComputerUseRightClickAction: Schema.Struct<{
1068
1070
  /**
1069
1071
  * Computer-use action payload for performing a right click, optionally at a specific coordinate.
1070
1072
  *
1071
- * @category Computer Use
1073
+ * @category computer use
1072
1074
  * @since 4.0.0
1073
1075
  */
1074
1076
  export type ComputerUseRightClickAction = typeof ComputerUseRightClickAction.Type;
@@ -1092,7 +1094,7 @@ export type ComputerUseRightClickAction = typeof ComputerUseRightClickAction.Typ
1092
1094
  * @see {@link ComputerUse_20250124} for the tool version that accepts this action
1093
1095
  * @see {@link ScrollDirection} for the accepted direction literals
1094
1096
  *
1095
- * @category Computer Use
1097
+ * @category computer use
1096
1098
  * @since 4.0.0
1097
1099
  */
1098
1100
  export declare const ComputerUseScrollAction: Schema.Struct<{
@@ -1114,7 +1116,7 @@ export declare const ComputerUseScrollAction: Schema.Struct<{
1114
1116
  /**
1115
1117
  * Computer-use action payload for scrolling by a specified amount in a specified direction, optionally from a coordinate.
1116
1118
  *
1117
- * @category Computer Use
1119
+ * @category computer use
1118
1120
  * @since 4.0.0
1119
1121
  */
1120
1122
  export type ComputerUseScrollAction = typeof ComputerUseScrollAction.Type;
@@ -1140,7 +1142,7 @@ export type ComputerUseScrollAction = typeof ComputerUseScrollAction.Type;
1140
1142
  * @see {@link ComputerUseDoubleClickAction} for the two-click variant
1141
1143
  * @see {@link ComputerUseLeftClickAction} for a single left click
1142
1144
  *
1143
- * @category Computer Use
1145
+ * @category computer use
1144
1146
  * @since 4.0.0
1145
1147
  */
1146
1148
  export declare const ComputerUseTripleClickAction: Schema.Struct<{
@@ -1154,7 +1156,7 @@ export declare const ComputerUseTripleClickAction: Schema.Struct<{
1154
1156
  /**
1155
1157
  * Computer-use action payload for performing a triple click, optionally at a specific coordinate.
1156
1158
  *
1157
- * @category Computer Use
1159
+ * @category computer use
1158
1160
  * @since 4.0.0
1159
1161
  */
1160
1162
  export type ComputerUseTripleClickAction = typeof ComputerUseTripleClickAction.Type;
@@ -1179,7 +1181,7 @@ export type ComputerUseTripleClickAction = typeof ComputerUseTripleClickAction.T
1179
1181
  * @see {@link ComputerUseHoldKeyAction} for another duration-based computer-use action
1180
1182
  * @see {@link ComputerUse_20250124} for the tool version that accepts this action
1181
1183
  *
1182
- * @category Computer Use
1184
+ * @category computer use
1183
1185
  * @since 4.0.0
1184
1186
  */
1185
1187
  export declare const ComputerUseWaitAction: Schema.Struct<{
@@ -1192,12 +1194,12 @@ export declare const ComputerUseWaitAction: Schema.Struct<{
1192
1194
  /**
1193
1195
  * Computer-use action payload for pausing for a specified duration.
1194
1196
  *
1195
- * @category Computer Use
1197
+ * @category computer use
1196
1198
  * @since 4.0.0
1197
1199
  */
1198
1200
  export type ComputerUseWaitAction = typeof ComputerUseWaitAction.Type;
1199
1201
  /**
1200
- * Zoom into a specific region of the screen at full resolution.
1202
+ * Zooms into a specific region of the screen at full resolution.
1201
1203
  *
1202
1204
  * **Details**
1203
1205
  *
@@ -1211,7 +1213,7 @@ export type ComputerUseWaitAction = typeof ComputerUseWaitAction.Type;
1211
1213
  * @see {@link ComputerUse_20251124} for the tool version that accepts this action
1212
1214
  * @see {@link ComputerUseScreenshotAction} for capturing the full screen instead
1213
1215
  *
1214
- * @category Computer Use
1216
+ * @category computer use
1215
1217
  * @since 4.0.0
1216
1218
  */
1217
1219
  export declare const ComputerUseZoomAction: Schema.Struct<{
@@ -1231,19 +1233,19 @@ export declare const ComputerUseZoomAction: Schema.Struct<{
1231
1233
  * `region` is only a four-number tuple and does not validate corner ordering or
1232
1234
  * display bounds.
1233
1235
  *
1234
- * @category Computer Use
1236
+ * @category computer use
1235
1237
  * @since 4.0.0
1236
1238
  */
1237
1239
  export type ComputerUseZoomAction = typeof ComputerUseZoomAction.Type;
1238
1240
  /**
1239
- * Computer use tool for Claude 3.5 Sonnet v2 (deprecated).
1241
+ * Defines the deprecated computer-use tool for Claude 3.5 Sonnet v2.
1240
1242
  *
1241
1243
  * **Details**
1242
1244
  *
1243
1245
  * Requires the "computer-use-2024-10-22" beta header.
1244
1246
  * Basic actions only: screenshot, left_click, type, key, mouse_move.
1245
1247
  *
1246
- * @category Computer Use
1248
+ * @category computer use
1247
1249
  * @since 4.0.0
1248
1250
  */
1249
1251
  export declare const ComputerUse_20241022: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
@@ -1301,7 +1303,7 @@ export declare const ComputerUse_20241022: <Mode extends Tool.FailureMode | unde
1301
1303
  readonly failureMode: Mode extends undefined ? "error" : Mode;
1302
1304
  }, true>;
1303
1305
  /**
1304
- * Computer use tool for Claude 4 models and Claude Sonnet 3.7.
1306
+ * Defines the computer-use tool for Claude 4 models and Claude Sonnet 3.7.
1305
1307
  *
1306
1308
  * **When to use**
1307
1309
  *
@@ -1318,7 +1320,7 @@ export declare const ComputerUse_20241022: <Mode extends Tool.FailureMode | unde
1318
1320
  * @see {@link ComputerUse_20241022} for the older basic action set
1319
1321
  * @see {@link ComputerUse_20251124} for the newer zoom-capable version
1320
1322
  *
1321
- * @category Computer Use
1323
+ * @category computer use
1322
1324
  * @since 4.0.0
1323
1325
  */
1324
1326
  export declare const ComputerUse_20250124: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
@@ -1459,7 +1461,7 @@ export declare const ComputerUse_20250124: <Mode extends Tool.FailureMode | unde
1459
1461
  readonly failureMode: Mode extends undefined ? "error" : Mode;
1460
1462
  }, true>;
1461
1463
  /**
1462
- * Computer use tool for Claude Opus 4.5 only.
1464
+ * Defines the computer-use tool for Claude Opus 4.5 only.
1463
1465
  *
1464
1466
  * **When to use**
1465
1467
  *
@@ -1479,7 +1481,7 @@ export declare const ComputerUse_20250124: <Mode extends Tool.FailureMode | unde
1479
1481
  * @see {@link ComputerUse_20250124} for the previous action set without zoom
1480
1482
  * @see {@link ComputerUseZoomAction} for the zoom action payload
1481
1483
  *
1482
- * @category Computer Use
1484
+ * @category computer use
1483
1485
  * @since 4.0.0
1484
1486
  */
1485
1487
  export declare const ComputerUse_20251124: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
@@ -1629,7 +1631,7 @@ export declare const ComputerUse_20251124: <Mode extends Tool.FailureMode | unde
1629
1631
  readonly failureMode: Mode extends undefined ? "error" : Mode;
1630
1632
  }, true>;
1631
1633
  /**
1632
- * A `[start, end]` line range for viewing file contents.
1634
+ * Defines a `[start, end]` line range for viewing file contents.
1633
1635
  *
1634
1636
  * **When to use**
1635
1637
  *
@@ -1645,7 +1647,7 @@ export declare const ComputerUse_20251124: <Mode extends Tool.FailureMode | unde
1645
1647
  * @see {@link MemoryViewCommand} for memory view payloads that use this range
1646
1648
  * @see {@link TextEditorViewCommand} for text editor view payloads that use this range
1647
1649
  *
1648
- * @category Memory
1650
+ * @category memory
1649
1651
  * @since 4.0.0
1650
1652
  */
1651
1653
  export declare const ViewRange: Schema.Tuple<readonly [Schema.Number, Schema.Number]>;
@@ -1656,7 +1658,7 @@ export declare const ViewRange: Schema.Tuple<readonly [Schema.Number, Schema.Num
1656
1658
  *
1657
1659
  * Use when typing `view_range` for memory or text editor view commands.
1658
1660
  *
1659
- * @category Memory
1661
+ * @category memory
1660
1662
  * @since 4.0.0
1661
1663
  */
1662
1664
  export type ViewRange = typeof ViewRange.Type;
@@ -1667,7 +1669,7 @@ export type ViewRange = typeof ViewRange.Type;
1667
1669
  *
1668
1670
  * The payload contains `command: "create"` and a `path` string.
1669
1671
  *
1670
- * @category Memory
1672
+ * @category memory
1671
1673
  * @since 4.0.0
1672
1674
  */
1673
1675
  export declare const MemoryCreateCommand: Schema.Struct<{
@@ -1680,14 +1682,14 @@ export declare const MemoryCreateCommand: Schema.Struct<{
1680
1682
  /**
1681
1683
  * Memory tool command payload for creating a new file at a path.
1682
1684
  *
1683
- * @category Memory
1685
+ * @category memory
1684
1686
  * @since 4.0.0
1685
1687
  */
1686
1688
  export type MemoryCreateCommand = typeof MemoryCreateCommand.Type;
1687
1689
  /**
1688
1690
  * Schema for a memory command that deletes a file or directory.
1689
1691
  *
1690
- * @category Memory
1692
+ * @category memory
1691
1693
  * @since 4.0.0
1692
1694
  */
1693
1695
  export declare const MemoryDeleteCommand: Schema.Struct<{
@@ -1700,7 +1702,7 @@ export declare const MemoryDeleteCommand: Schema.Struct<{
1700
1702
  /**
1701
1703
  * Memory tool command payload for deleting a file or directory at a path.
1702
1704
  *
1703
- * @category Memory
1705
+ * @category memory
1704
1706
  * @since 4.0.0
1705
1707
  */
1706
1708
  export type MemoryDeleteCommand = typeof MemoryDeleteCommand.Type;
@@ -1719,7 +1721,7 @@ export type MemoryDeleteCommand = typeof MemoryDeleteCommand.Type;
1719
1721
  * @see {@link Memory_20250818} for the provider-defined tool that consumes this command
1720
1722
  * @see {@link MemoryStrReplaceCommand} for replacing existing text instead
1721
1723
  *
1722
- * @category Memory
1724
+ * @category memory
1723
1725
  * @since 4.0.0
1724
1726
  */
1725
1727
  export declare const MemoryInsertCommand: Schema.Struct<{
@@ -1740,7 +1742,7 @@ export declare const MemoryInsertCommand: Schema.Struct<{
1740
1742
  /**
1741
1743
  * Memory tool command payload for inserting text at a specific line in a file.
1742
1744
  *
1743
- * @category Memory
1745
+ * @category memory
1744
1746
  * @since 4.0.0
1745
1747
  */
1746
1748
  export type MemoryInsertCommand = typeof MemoryInsertCommand.Type;
@@ -1752,7 +1754,7 @@ export type MemoryInsertCommand = typeof MemoryInsertCommand.Type;
1752
1754
  * The payload uses `command: "rename"` and requires `old_path` as the current
1753
1755
  * path plus `new_path` as the new destination path.
1754
1756
  *
1755
- * @category Memory
1757
+ * @category memory
1756
1758
  * @since 4.0.0
1757
1759
  */
1758
1760
  export declare const MemoryRenameCommand: Schema.Struct<{
@@ -1769,7 +1771,7 @@ export declare const MemoryRenameCommand: Schema.Struct<{
1769
1771
  /**
1770
1772
  * Memory tool command payload for renaming or moving a file or directory.
1771
1773
  *
1772
- * @category Memory
1774
+ * @category memory
1773
1775
  * @since 4.0.0
1774
1776
  */
1775
1777
  export type MemoryRenameCommand = typeof MemoryRenameCommand.Type;
@@ -1788,7 +1790,7 @@ export type MemoryRenameCommand = typeof MemoryRenameCommand.Type;
1788
1790
  *
1789
1791
  * @see {@link Memory_20250818} for the provider-defined tool that consumes this command
1790
1792
  *
1791
- * @category Memory
1793
+ * @category memory
1792
1794
  * @since 4.0.0
1793
1795
  */
1794
1796
  export declare const MemoryStrReplaceCommand: Schema.Struct<{
@@ -1809,7 +1811,7 @@ export declare const MemoryStrReplaceCommand: Schema.Struct<{
1809
1811
  /**
1810
1812
  * Memory tool command payload for replacing text in a file.
1811
1813
  *
1812
- * @category Memory
1814
+ * @category memory
1813
1815
  * @since 4.0.0
1814
1816
  */
1815
1817
  export type MemoryStrReplaceCommand = typeof MemoryStrReplaceCommand.Type;
@@ -1821,7 +1823,7 @@ export type MemoryStrReplaceCommand = typeof MemoryStrReplaceCommand.Type;
1821
1823
  * When used on a file, returns file contents optionally limited by `view_range`.
1822
1824
  * When used on a directory, lists contents.
1823
1825
  *
1824
- * @category Memory
1826
+ * @category memory
1825
1827
  * @since 4.0.0
1826
1828
  */
1827
1829
  export declare const MemoryViewCommand: Schema.Struct<{
@@ -1838,19 +1840,19 @@ export declare const MemoryViewCommand: Schema.Struct<{
1838
1840
  /**
1839
1841
  * Memory tool command payload for viewing a file or directory, optionally with a file line range.
1840
1842
  *
1841
- * @category Memory
1843
+ * @category memory
1842
1844
  * @since 4.0.0
1843
1845
  */
1844
1846
  export type MemoryViewCommand = typeof MemoryViewCommand.Type;
1845
1847
  /**
1846
- * Memory tool for persistent file operations across conversations.
1848
+ * Defines the memory tool for persistent file operations across conversations.
1847
1849
  *
1848
1850
  * **Details**
1849
1851
  *
1850
1852
  * Provides commands for creating, viewing, editing, renaming, and deleting
1851
1853
  * files within the model's memory space.
1852
1854
  *
1853
- * @category Memory
1855
+ * @category memory
1854
1856
  * @since 4.0.0
1855
1857
  */
1856
1858
  export declare const Memory_20250818: <Mode extends Tool.FailureMode | undefined = undefined>(args: void) => Tool.ProviderDefined<"anthropic.memory_20250818", "AnthropicMemory", {
@@ -1921,7 +1923,7 @@ export declare const Memory_20250818: <Mode extends Tool.FailureMode | undefined
1921
1923
  readonly failureMode: Mode extends undefined ? "error" : Mode;
1922
1924
  }, false>;
1923
1925
  /**
1924
- * View the contents of a file or list directory contents.
1926
+ * Reads the contents of a file or lists directory contents.
1925
1927
  *
1926
1928
  * **When to use**
1927
1929
  *
@@ -1937,7 +1939,7 @@ export declare const Memory_20250818: <Mode extends Tool.FailureMode | undefined
1937
1939
  *
1938
1940
  * @see {@link CodeExecutionTextEditorView} for the code-execution variant without `view_range`
1939
1941
  *
1940
- * @category Text Editor
1942
+ * @category text editor
1941
1943
  * @since 4.0.0
1942
1944
  */
1943
1945
  export declare const TextEditorViewCommand: Schema.Struct<{
@@ -1960,7 +1962,7 @@ export declare const TextEditorViewCommand: Schema.Struct<{
1960
1962
  * `view_range` is a 1-indexed `[start, end]` tuple where `-1` means through
1961
1963
  * the end of the file.
1962
1964
  *
1963
- * @category Text Editor
1965
+ * @category text editor
1964
1966
  * @since 4.0.0
1965
1967
  */
1966
1968
  export type TextEditorViewCommand = typeof TextEditorViewCommand.Type;
@@ -1981,7 +1983,7 @@ export type TextEditorViewCommand = typeof TextEditorViewCommand.Type;
1981
1983
  *
1982
1984
  * Fails if the file already exists. Parent directories must exist.
1983
1985
  *
1984
- * @category Text Editor
1986
+ * @category text editor
1985
1987
  * @since 4.0.0
1986
1988
  */
1987
1989
  export declare const TextEditorCreateCommand: Schema.Struct<{
@@ -2002,12 +2004,12 @@ export declare const TextEditorCreateCommand: Schema.Struct<{
2002
2004
  *
2003
2005
  * The command fails if the file already exists or if parent directories are missing.
2004
2006
  *
2005
- * @category Text Editor
2007
+ * @category text editor
2006
2008
  * @since 4.0.0
2007
2009
  */
2008
2010
  export type TextEditorCreateCommand = typeof TextEditorCreateCommand.Type;
2009
2011
  /**
2010
- * Replace a specific string in a file with a new string.
2012
+ * Replaces a specific string in a file with a new string.
2011
2013
  *
2012
2014
  * **When to use**
2013
2015
  *
@@ -2027,7 +2029,7 @@ export type TextEditorCreateCommand = typeof TextEditorCreateCommand.Type;
2027
2029
  * @see {@link TextEditorViewCommand} for reading contents before choosing `old_str`
2028
2030
  * @see {@link CodeExecutionTextEditorStrReplace} for the code-execution variant
2029
2031
  *
2030
- * @category Text Editor
2032
+ * @category text editor
2031
2033
  * @since 4.0.0
2032
2034
  */
2033
2035
  export declare const TextEditorStrReplaceCommand: Schema.Struct<{
@@ -2053,19 +2055,19 @@ export declare const TextEditorStrReplaceCommand: Schema.Struct<{
2053
2055
  * The `old_str` must match exactly, including whitespace and indentation, and
2054
2056
  * must be unique in the file.
2055
2057
  *
2056
- * @category Text Editor
2058
+ * @category text editor
2057
2059
  * @since 4.0.0
2058
2060
  */
2059
2061
  export type TextEditorStrReplaceCommand = typeof TextEditorStrReplaceCommand.Type;
2060
2062
  /**
2061
- * Insert text at a specific line number in a file.
2063
+ * Inserts text at a specific line number in a file.
2062
2064
  *
2063
2065
  * **Details**
2064
2066
  *
2065
2067
  * Inserts the new text after the specified line number. Use `0` to insert at
2066
2068
  * the beginning of the file; other values are 1-indexed.
2067
2069
  *
2068
- * @category Text Editor
2070
+ * @category text editor
2069
2071
  * @since 4.0.0
2070
2072
  */
2071
2073
  export declare const TextEditorInsertCommand: Schema.Struct<{
@@ -2086,12 +2088,12 @@ export declare const TextEditorInsertCommand: Schema.Struct<{
2086
2088
  /**
2087
2089
  * Text editor command payload for inserting text after a specific line number in a file.
2088
2090
  *
2089
- * @category Text Editor
2091
+ * @category text editor
2090
2092
  * @since 4.0.0
2091
2093
  */
2092
2094
  export type TextEditorInsertCommand = typeof TextEditorInsertCommand.Type;
2093
2095
  /**
2094
- * Undo the last edit made to a file.
2096
+ * Undoes the last edit made to a file.
2095
2097
  *
2096
2098
  * **Details**
2097
2099
  *
@@ -2104,7 +2106,7 @@ export type TextEditorInsertCommand = typeof TextEditorInsertCommand.Type;
2104
2106
  * `text_editor_20250124`, but not in `text_editor_20250429` or
2105
2107
  * `text_editor_20250728`.
2106
2108
  *
2107
- * @category Text Editor
2109
+ * @category text editor
2108
2110
  * @since 4.0.0
2109
2111
  */
2110
2112
  export declare const TextEditorUndoEditCommand: Schema.Struct<{
@@ -2122,12 +2124,12 @@ export declare const TextEditorUndoEditCommand: Schema.Struct<{
2122
2124
  * Available for `text_editor_20241022` and `text_editor_20250124`, but not for
2123
2125
  * `text_editor_20250429` or `text_editor_20250728`.
2124
2126
  *
2125
- * @category Text Editor
2127
+ * @category text editor
2126
2128
  * @since 4.0.0
2127
2129
  */
2128
2130
  export type TextEditorUndoEditCommand = typeof TextEditorUndoEditCommand.Type;
2129
2131
  /**
2130
- * Text editor tool for Claude 3.5 Sonnet (deprecated).
2132
+ * Defines the deprecated text editor tool for Claude 3.5 Sonnet.
2131
2133
  *
2132
2134
  * **When to use**
2133
2135
  *
@@ -2142,7 +2144,7 @@ export type TextEditorUndoEditCommand = typeof TextEditorUndoEditCommand.Type;
2142
2144
  * @see {@link TextEditor_20250124} for the newer `str_replace_editor` version
2143
2145
  * @see {@link TextEditor_20250728} for the Claude 4 `str_replace_based_edit_tool` line
2144
2146
  *
2145
- * @category Text Editor
2147
+ * @category text editor
2146
2148
  * @since 4.0.0
2147
2149
  */
2148
2150
  export declare const TextEditor_20241022: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
@@ -2210,7 +2212,7 @@ export declare const TextEditor_20241022: <Mode extends Tool.FailureMode | undef
2210
2212
  readonly failureMode: Mode extends undefined ? "error" : Mode;
2211
2213
  }, true>;
2212
2214
  /**
2213
- * Text editor tool for Claude Sonnet 3.7 (deprecated model).
2215
+ * Defines the text editor tool for deprecated Claude Sonnet 3.7.
2214
2216
  *
2215
2217
  * **When to use**
2216
2218
  *
@@ -2225,7 +2227,7 @@ export declare const TextEditor_20241022: <Mode extends Tool.FailureMode | undef
2225
2227
  * @see {@link TextEditor_20241022} for the older `str_replace_editor` version
2226
2228
  * @see {@link TextEditor_20250429} for the Claude 4 `str_replace_based_edit_tool` line
2227
2229
  *
2228
- * @category Text Editor
2230
+ * @category text editor
2229
2231
  * @since 4.0.0
2230
2232
  */
2231
2233
  export declare const TextEditor_20250124: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
@@ -2293,7 +2295,7 @@ export declare const TextEditor_20250124: <Mode extends Tool.FailureMode | undef
2293
2295
  readonly failureMode: Mode extends undefined ? "error" : Mode;
2294
2296
  }, true>;
2295
2297
  /**
2296
- * Text editor tool for Claude 4 models using Anthropic's `str_replace_based_edit_tool`.
2298
+ * Defines the text editor tool for Claude 4 models using Anthropic's `str_replace_based_edit_tool`.
2297
2299
  *
2298
2300
  * **When to use**
2299
2301
  *
@@ -2311,7 +2313,7 @@ export declare const TextEditor_20250124: <Mode extends Tool.FailureMode | undef
2311
2313
  * @see {@link TextEditor_20250124} for the previous `str_replace_editor` version
2312
2314
  * @see {@link TextEditor_20250728} for the later Claude 4 text editor version
2313
2315
  *
2314
- * @category Text Editor
2316
+ * @category text editor
2315
2317
  * @since 4.0.0
2316
2318
  */
2317
2319
  export declare const TextEditor_20250429: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
@@ -2380,7 +2382,7 @@ export declare const TextEditor_20250429: <Mode extends Tool.FailureMode | undef
2380
2382
  readonly failureMode: Mode extends undefined ? "error" : Mode;
2381
2383
  }, true>;
2382
2384
  /**
2383
- * Text editor tool for Claude 4 models.
2385
+ * Defines the text editor tool for Claude 4 models.
2384
2386
  *
2385
2387
  * **Details**
2386
2388
  *
@@ -2391,7 +2393,7 @@ export declare const TextEditor_20250429: <Mode extends Tool.FailureMode | undef
2391
2393
  *
2392
2394
  * This version does not support the `undo_edit` command.
2393
2395
  *
2394
- * @category Text Editor
2396
+ * @category text editor
2395
2397
  * @since 4.0.0
2396
2398
  */
2397
2399
  export declare const TextEditor_20250728: <Mode extends Tool.FailureMode | undefined = undefined>(args: {
@@ -2460,7 +2462,7 @@ export declare const TextEditor_20250728: <Mode extends Tool.FailureMode | undef
2460
2462
  readonly failureMode: Mode extends undefined ? "error" : Mode;
2461
2463
  }, true>;
2462
2464
  /**
2463
- * User location for localizing search results.
2465
+ * Describes user location for localizing search results.
2464
2466
  *
2465
2467
  * **When to use**
2466
2468
  *
@@ -2501,7 +2503,7 @@ export declare const WebSearchUserLocation: Schema.Struct<{
2501
2503
  readonly timezone: Schema.optional<Schema.String>;
2502
2504
  }>;
2503
2505
  /**
2504
- * Configuration arguments for the web search tool.
2506
+ * Defines configuration arguments for the web search tool.
2505
2507
  *
2506
2508
  * **When to use**
2507
2509
  *
@@ -2610,7 +2612,7 @@ export declare const WebSearchParameters: Schema.Struct<{
2610
2612
  */
2611
2613
  export type WebSearchParameters = typeof WebSearchParameters.Type;
2612
2614
  /**
2613
- * Web search tool for Claude models.
2615
+ * Defines the web search tool for Claude models.
2614
2616
  *
2615
2617
  * **When to use**
2616
2618
  *
@@ -2702,7 +2704,7 @@ export declare const WebSearch_20250305: <Mode extends Tool.FailureMode | undefi
2702
2704
  readonly failureMode: Mode extends undefined ? "error" : Mode;
2703
2705
  }, false>;
2704
2706
  /**
2705
- * Citation configuration for web fetch.
2707
+ * Defines citation configuration for web fetch.
2706
2708
  *
2707
2709
  * **When to use**
2708
2710
  *
@@ -2739,7 +2741,7 @@ export declare const WebFetchCitationsConfig: Schema.Struct<{
2739
2741
  */
2740
2742
  export type WebFetchCitationsConfig = typeof WebFetchCitationsConfig.Type;
2741
2743
  /**
2742
- * Configuration arguments for the web fetch tool.
2744
+ * Defines configuration arguments for the web fetch tool.
2743
2745
  *
2744
2746
  * **When to use**
2745
2747
  *
@@ -2853,7 +2855,7 @@ export declare const WebFetchParameters: Schema.Struct<{
2853
2855
  */
2854
2856
  export type WebFetchParameters = typeof WebFetchParameters.Type;
2855
2857
  /**
2856
- * Web fetch tool for Claude models.
2858
+ * Defines the web fetch tool for Claude models.
2857
2859
  *
2858
2860
  * **When to use**
2859
2861
  *
@@ -2945,14 +2947,14 @@ export declare const WebFetch_20250910: <Mode extends Tool.FailureMode | undefin
2945
2947
  readonly failureMode: Mode extends undefined ? "error" : Mode;
2946
2948
  }, false>;
2947
2949
  /**
2948
- * Input parameters for regex-based tool search.
2950
+ * Schema for regex-based tool search input parameters.
2949
2951
  *
2950
2952
  * **Details**
2951
2953
  *
2952
2954
  * Claude constructs regex patterns using Python's `re.search()` syntax.
2953
2955
  * Maximum query length: 200 characters.
2954
2956
  *
2955
- * @category Tool Search
2957
+ * @category tool search
2956
2958
  * @since 4.0.0
2957
2959
  */
2958
2960
  export declare const ToolSearchRegexParameters: Schema.Struct<{
@@ -2969,12 +2971,12 @@ export declare const ToolSearchRegexParameters: Schema.Struct<{
2969
2971
  * Claude constructs regex patterns using Python's `re.search()` syntax.
2970
2972
  * Maximum query length: 200 characters.
2971
2973
  *
2972
- * @category Tool Search
2974
+ * @category tool search
2973
2975
  * @since 4.0.0
2974
2976
  */
2975
2977
  export type ToolSearchRegexParameters = typeof ToolSearchRegexParameters.Type;
2976
2978
  /**
2977
- * Input parameters for BM25/natural language tool search.
2979
+ * Defines input parameters for BM25/natural language tool search.
2978
2980
  *
2979
2981
  * **When to use**
2980
2982
  *
@@ -2988,7 +2990,7 @@ export type ToolSearchRegexParameters = typeof ToolSearchRegexParameters.Type;
2988
2990
  *
2989
2991
  * @see {@link ToolSearchBM25_20251119} for the provider-defined tool that consumes these parameters
2990
2992
  *
2991
- * @category Tool Search
2993
+ * @category tool search
2992
2994
  * @since 4.0.0
2993
2995
  */
2994
2996
  export declare const ToolSearchBM25Parameters: Schema.Struct<{
@@ -3000,12 +3002,12 @@ export declare const ToolSearchBM25Parameters: Schema.Struct<{
3000
3002
  /**
3001
3003
  * Type of the parameters Claude supplies when invoking BM25 natural-language Anthropic tool search.
3002
3004
  *
3003
- * @category Tool Search
3005
+ * @category tool search
3004
3006
  * @since 4.0.0
3005
3007
  */
3006
3008
  export type ToolSearchBM25Parameters = typeof ToolSearchBM25Parameters.Type;
3007
3009
  /**
3008
- * Regex-based tool search for Claude models.
3010
+ * Defines regex-based tool search for Claude models.
3009
3011
  *
3010
3012
  * **Details**
3011
3013
  *
@@ -3014,7 +3016,7 @@ export type ToolSearchBM25Parameters = typeof ToolSearchBM25Parameters.Type;
3014
3016
  * argument names, and argument descriptions.
3015
3017
  * Requires the "advanced-tool-use-2025-11-20" beta header.
3016
3018
  *
3017
- * @category Tool Search
3019
+ * @category tool search
3018
3020
  * @since 4.0.0
3019
3021
  */
3020
3022
  export declare const ToolSearchRegex_20251119: <Mode extends Tool.FailureMode | undefined = undefined>(args: void) => Tool.ProviderDefined<"anthropic.tool_search_tool_regex_20251119", "AnthropicToolSearchRegex", {
@@ -3041,7 +3043,7 @@ export declare const ToolSearchRegex_20251119: <Mode extends Tool.FailureMode |
3041
3043
  readonly failureMode: Mode extends undefined ? "error" : Mode;
3042
3044
  }, false>;
3043
3045
  /**
3044
- * BM25/natural language tool search for Claude models.
3046
+ * Defines BM25/natural language tool search for Claude models.
3045
3047
  *
3046
3048
  * **When to use**
3047
3049
  *
@@ -3057,7 +3059,7 @@ export declare const ToolSearchRegex_20251119: <Mode extends Tool.FailureMode |
3057
3059
  *
3058
3060
  * @see {@link ToolSearchRegex_20251119} for the regex-pattern alternative
3059
3061
  *
3060
- * @category Tool Search
3062
+ * @category tool search
3061
3063
  * @since 4.0.0
3062
3064
  */
3063
3065
  export declare const ToolSearchBM25_20251119: <Mode extends Tool.FailureMode | undefined = undefined>(args: void) => Tool.ProviderDefined<"anthropic.tool_search_tool_bm25_20251119", "AnthropicToolSearchBM25", {