@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.
@@ -100,7 +100,7 @@ export type AnthropicTool =
100
100
  // =============================================================================
101
101
 
102
102
  /**
103
- * Anthropic Bash tool (2024-10-22 version).
103
+ * Defines the Anthropic Bash tool (2024-10-22 version).
104
104
  *
105
105
  * **When to use**
106
106
  *
@@ -130,7 +130,7 @@ export const Bash_20241022 = Tool.providerDefined({
130
130
  })
131
131
 
132
132
  /**
133
- * Anthropic Bash tool (2025-01-24 version).
133
+ * Defines the Anthropic Bash tool (2025-01-24 version).
134
134
  *
135
135
  * **When to use**
136
136
  *
@@ -438,7 +438,7 @@ export type CodeExecution_20250825_Parameters = typeof CodeExecution_20250825_Pa
438
438
  // -----------------------------------------------------------------------------
439
439
 
440
440
  /**
441
- * Anthropic Code Execution tool (2025-05-22 version).
441
+ * Defines the Anthropic Code Execution tool (2025-05-22 version).
442
442
  *
443
443
  * **When to use**
444
444
  *
@@ -466,7 +466,7 @@ export const CodeExecution_20250522 = Tool.providerDefined({
466
466
  })
467
467
 
468
468
  /**
469
- * Anthropic Code Execution tool (2025-08-25 version).
469
+ * Defines the Anthropic Code Execution tool (2025-08-25 version).
470
470
  *
471
471
  * **When to use**
472
472
  *
@@ -523,14 +523,14 @@ export const CodeExecution_20250825 = Tool.providerDefined({
523
523
  *
524
524
  * This schema validates tuple shape only and does not check display bounds.
525
525
  *
526
- * @category Computer Use
526
+ * @category computer use
527
527
  * @since 4.0.0
528
528
  */
529
529
  export const Coordinate = Schema.Tuple([Schema.Number, Schema.Number])
530
530
  /**
531
531
  * An `[x, y]` screen coordinate in pixels.
532
532
  *
533
- * @category Computer Use
533
+ * @category computer use
534
534
  * @since 4.0.0
535
535
  */
536
536
  export type Coordinate = typeof Coordinate.Type
@@ -547,54 +547,54 @@ export type Coordinate = typeof Coordinate.Type
547
547
  * This schema validates four numbers only and does not check coordinate ordering
548
548
  * or display bounds.
549
549
  *
550
- * @category Computer Use
550
+ * @category computer use
551
551
  * @since 4.0.0
552
552
  */
553
553
  export const Region = Schema.Tuple([Schema.Number, Schema.Number, Schema.Number, Schema.Number])
554
554
  /**
555
555
  * An `[x1, y1, x2, y2]` screen region in pixels, from top-left to bottom-right.
556
556
  *
557
- * @category Computer Use
557
+ * @category computer use
558
558
  * @since 4.0.0
559
559
  */
560
560
  export type Region = typeof Region.Type
561
561
 
562
562
  /**
563
- * Scroll direction literal: `"up"`, `"down"`, `"left"`, or `"right"`.
563
+ * Schema for scroll direction literals: `"up"`, `"down"`, `"left"`, or `"right"`.
564
564
  *
565
565
  * @see {@link ComputerUseScrollAction} for the action payload that consumes this schema
566
566
  *
567
- * @category Computer Use
567
+ * @category computer use
568
568
  * @since 4.0.0
569
569
  */
570
570
  export const ScrollDirection = Schema.Literals(["up", "down", "left", "right"])
571
571
  /**
572
572
  * Direction used by computer-use scroll actions: `"up"`, `"down"`, `"left"`, or `"right"`.
573
573
  *
574
- * @category Computer Use
574
+ * @category computer use
575
575
  * @since 4.0.0
576
576
  */
577
577
  export type ScrollDirection = typeof ScrollDirection.Type
578
578
 
579
579
  /**
580
- * Modifier key literal.
580
+ * Schema for modifier key literals.
581
581
  *
582
582
  * **Details**
583
583
  *
584
584
  * Allowed values are `"alt"`, `"ctrl"`, `"meta"`, and `"shift"`.
585
585
  *
586
- * @category Computer Use
586
+ * @category computer use
587
587
  * @since 4.0.0
588
588
  */
589
589
  export const ModifierKey = Schema.Literals(["alt", "ctrl", "meta", "shift"])
590
590
  /**
591
- * Modifier key literal.
591
+ * Modifier key literals.
592
592
  *
593
593
  * **Details**
594
594
  *
595
595
  * Allowed values are `"alt"`, `"ctrl"`, `"meta"`, and `"shift"`.
596
596
  *
597
- * @category Computer Use
597
+ * @category computer use
598
598
  * @since 4.0.0
599
599
  */
600
600
  export type ModifierKey = typeof ModifierKey.Type
@@ -643,7 +643,7 @@ const ComputerUse_20251124_Args = Schema.Struct({
643
643
  * @see {@link TypeAction} for entering ordinary text strings
644
644
  * @see {@link ComputerUseHoldKeyAction} for holding a key for a duration
645
645
  *
646
- * @category Computer Use
646
+ * @category computer use
647
647
  * @since 4.0.0
648
648
  */
649
649
  export const ComputerUseKeyAction = Schema.Struct({
@@ -666,7 +666,7 @@ export const ComputerUseKeyAction = Schema.Struct({
666
666
  * `text` is typed as `string`; the paired schema does not validate
667
667
  * provider-specific key names or key combinations.
668
668
  *
669
- * @category Computer Use
669
+ * @category computer use
670
670
  * @since 4.0.0
671
671
  */
672
672
  export type ComputerUseKeyAction = typeof ComputerUseKeyAction.Type
@@ -694,7 +694,7 @@ export type ComputerUseKeyAction = typeof ComputerUseKeyAction.Type
694
694
  * @see {@link ComputerUseDoubleClickAction} for performing a double click
695
695
  * @see {@link ComputerUseMouseMoveAction} for moving the mouse without clicking
696
696
  *
697
- * @category Computer Use
697
+ * @category computer use
698
698
  * @since 4.0.0
699
699
  */
700
700
  export const ComputerUseLeftClickAction = Schema.Struct({
@@ -708,7 +708,7 @@ export const ComputerUseLeftClickAction = Schema.Struct({
708
708
  /**
709
709
  * Computer-use action payload for performing a left click, optionally at a specific coordinate.
710
710
  *
711
- * @category Computer Use
711
+ * @category computer use
712
712
  * @since 4.0.0
713
713
  */
714
714
  export type ComputerUseLeftClickAction = typeof ComputerUseLeftClickAction.Type
@@ -733,7 +733,7 @@ export type ComputerUseLeftClickAction = typeof ComputerUseLeftClickAction.Type
733
733
  * does not validate that the point falls within the configured display
734
734
  * dimensions.
735
735
  *
736
- * @category Computer Use
736
+ * @category computer use
737
737
  * @since 4.0.0
738
738
  */
739
739
  export const ComputerUseMouseMoveAction = Schema.Struct({
@@ -746,7 +746,7 @@ export const ComputerUseMouseMoveAction = Schema.Struct({
746
746
  /**
747
747
  * Computer-use action payload for moving the mouse cursor to a specific coordinate.
748
748
  *
749
- * @category Computer Use
749
+ * @category computer use
750
750
  * @since 4.0.0
751
751
  */
752
752
  export type ComputerUseMouseMoveAction = typeof ComputerUseMouseMoveAction.Type
@@ -766,7 +766,7 @@ export type ComputerUseMouseMoveAction = typeof ComputerUseMouseMoveAction.Type
766
766
  *
767
767
  * @see {@link ComputerUseZoomAction} for requesting a zoomed-in screenshot of a specific screen region with the 2025-11-24 computer-use tool
768
768
  *
769
- * @category Computer Use
769
+ * @category computer use
770
770
  * @since 4.0.0
771
771
  */
772
772
  export const ComputerUseScreenshotAction = Schema.Struct({
@@ -775,7 +775,7 @@ export const ComputerUseScreenshotAction = Schema.Struct({
775
775
  /**
776
776
  * Computer-use action payload for capturing the current display.
777
777
  *
778
- * @category Computer Use
778
+ * @category computer use
779
779
  * @since 4.0.0
780
780
  */
781
781
  export type ComputerUseScreenshotAction = typeof ComputerUseScreenshotAction.Type
@@ -795,7 +795,7 @@ export type ComputerUseScreenshotAction = typeof ComputerUseScreenshotAction.Typ
795
795
  *
796
796
  * @see {@link ComputerUseKeyAction} for key presses and keyboard shortcuts
797
797
  *
798
- * @category Computer Use
798
+ * @category computer use
799
799
  * @since 4.0.0
800
800
  */
801
801
  export const TypeAction = Schema.Struct({
@@ -813,7 +813,7 @@ export const TypeAction = Schema.Struct({
813
813
  * The payload uses `action: "type"` and a `text` string containing the text to
814
814
  * enter.
815
815
  *
816
- * @category Computer Use
816
+ * @category computer use
817
817
  * @since 4.0.0
818
818
  */
819
819
  export type TypeAction = typeof TypeAction.Type
@@ -852,7 +852,7 @@ const ComputerUse_20241022_Actions = Schema.Union([
852
852
  *
853
853
  * @see {@link ComputerUseLeftClickAction} for performing a single left click
854
854
  *
855
- * @category Computer Use
855
+ * @category computer use
856
856
  * @since 4.0.0
857
857
  */
858
858
  export const ComputerUseDoubleClickAction = Schema.Struct({
@@ -866,13 +866,13 @@ export const ComputerUseDoubleClickAction = Schema.Struct({
866
866
  /**
867
867
  * Computer-use action payload for performing a double click, optionally at a specific coordinate.
868
868
  *
869
- * @category Computer Use
869
+ * @category computer use
870
870
  * @since 4.0.0
871
871
  */
872
872
  export type ComputerUseDoubleClickAction = typeof ComputerUseDoubleClickAction.Type
873
873
 
874
874
  /**
875
- * Hold a key for a specified duration during computer-use execution.
875
+ * Keeps a key pressed for a specified duration during computer-use execution.
876
876
  *
877
877
  * **When to use**
878
878
  *
@@ -893,7 +893,7 @@ export type ComputerUseDoubleClickAction = typeof ComputerUseDoubleClickAction.T
893
893
  * @see {@link ComputerUseKeyAction} for pressing a key or key combination without holding it
894
894
  * @see {@link ComputerUseWaitAction} for pausing between actions without holding a key
895
895
  *
896
- * @category Computer Use
896
+ * @category computer use
897
897
  * @since 4.0.0
898
898
  */
899
899
  export const ComputerUseHoldKeyAction = Schema.Struct({
@@ -921,7 +921,7 @@ export const ComputerUseHoldKeyAction = Schema.Struct({
921
921
  *
922
922
  * @see {@link ComputerUseKeyAction} for a single key press or key combination without a hold duration
923
923
  *
924
- * @category Computer Use
924
+ * @category computer use
925
925
  * @since 4.0.0
926
926
  */
927
927
  export type ComputerUseHoldKeyAction = typeof ComputerUseHoldKeyAction.Type
@@ -948,7 +948,7 @@ export type ComputerUseHoldKeyAction = typeof ComputerUseHoldKeyAction.Type
948
948
  * @see {@link ComputerUseLeftMouseDownAction} for starting a manual drag sequence
949
949
  * @see {@link ComputerUseLeftMouseUpAction} for ending a manual drag sequence
950
950
  *
951
- * @category Computer Use
951
+ * @category computer use
952
952
  * @since 4.0.0
953
953
  */
954
954
  export const ComputerUseLeftClickDragAction = Schema.Struct({
@@ -965,19 +965,20 @@ export const ComputerUseLeftClickDragAction = Schema.Struct({
965
965
  /**
966
966
  * Computer-use action payload for dragging from a start coordinate to an end coordinate.
967
967
  *
968
- * @category Computer Use
968
+ * @category computer use
969
969
  * @since 4.0.0
970
970
  */
971
971
  export type ComputerUseLeftClickDragAction = typeof ComputerUseLeftClickDragAction.Type
972
972
 
973
973
  /**
974
- * Press the left mouse button down (without releasing).
974
+ * Starts a left mouse button press without releasing it.
975
975
  *
976
976
  * **When to use**
977
977
  *
978
- * Use when you use this for fine-grained click control.
978
+ * Use when constructing a manual click or drag sequence that should press and
979
+ * hold the left mouse button before a later release.
979
980
  *
980
- * @category Computer Use
981
+ * @category computer use
981
982
  * @since 4.0.0
982
983
  */
983
984
  export const ComputerUseLeftMouseDownAction = Schema.Struct({
@@ -991,19 +992,20 @@ export const ComputerUseLeftMouseDownAction = Schema.Struct({
991
992
  /**
992
993
  * Computer-use action payload for pressing and holding the left mouse button, optionally at a specific coordinate.
993
994
  *
994
- * @category Computer Use
995
+ * @category computer use
995
996
  * @since 4.0.0
996
997
  */
997
998
  export type ComputerUseLeftMouseDownAction = typeof ComputerUseLeftMouseDownAction.Type
998
999
 
999
1000
  /**
1000
- * Release the left mouse button.
1001
+ * Releases the left mouse button.
1001
1002
  *
1002
1003
  * **When to use**
1003
1004
  *
1004
- * Use when you use this for fine-grained click control.
1005
+ * Use when constructing a manual click or drag sequence that should release the
1006
+ * left mouse button after it was previously held down.
1005
1007
  *
1006
- * @category Computer Use
1008
+ * @category computer use
1007
1009
  * @since 4.0.0
1008
1010
  */
1009
1011
  export const ComputerUseLeftMouseUpAction = Schema.Struct({
@@ -1017,7 +1019,7 @@ export const ComputerUseLeftMouseUpAction = Schema.Struct({
1017
1019
  /**
1018
1020
  * Computer-use action payload for releasing the left mouse button, optionally at a specific coordinate.
1019
1021
  *
1020
- * @category Computer Use
1022
+ * @category computer use
1021
1023
  * @since 4.0.0
1022
1024
  */
1023
1025
  export type ComputerUseLeftMouseUpAction = typeof ComputerUseLeftMouseUpAction.Type
@@ -1044,7 +1046,7 @@ export type ComputerUseLeftMouseUpAction = typeof ComputerUseLeftMouseUpAction.T
1044
1046
  * @see {@link ComputerUseLeftClickAction} for primary-button clicks
1045
1047
  * @see {@link ComputerUseRightClickAction} for secondary-button clicks
1046
1048
  *
1047
- * @category Computer Use
1049
+ * @category computer use
1048
1050
  * @since 4.0.0
1049
1051
  */
1050
1052
  export const ComputerUseMiddleClickAction = Schema.Struct({
@@ -1058,7 +1060,7 @@ export const ComputerUseMiddleClickAction = Schema.Struct({
1058
1060
  /**
1059
1061
  * Computer-use action payload for performing a middle click, optionally at a specific coordinate.
1060
1062
  *
1061
- * @category Computer Use
1063
+ * @category computer use
1062
1064
  * @since 4.0.0
1063
1065
  */
1064
1066
  export type ComputerUseMiddleClickAction = typeof ComputerUseMiddleClickAction.Type
@@ -1081,7 +1083,7 @@ export type ComputerUseMiddleClickAction = typeof ComputerUseMiddleClickAction.T
1081
1083
  * @see {@link ComputerUseLeftClickAction} for the corresponding left-click action
1082
1084
  * @see {@link ComputerUseMiddleClickAction} for the corresponding middle-click action
1083
1085
  *
1084
- * @category Computer Use
1086
+ * @category computer use
1085
1087
  * @since 4.0.0
1086
1088
  */
1087
1089
  export const ComputerUseRightClickAction = Schema.Struct({
@@ -1095,7 +1097,7 @@ export const ComputerUseRightClickAction = Schema.Struct({
1095
1097
  /**
1096
1098
  * Computer-use action payload for performing a right click, optionally at a specific coordinate.
1097
1099
  *
1098
- * @category Computer Use
1100
+ * @category computer use
1099
1101
  * @since 4.0.0
1100
1102
  */
1101
1103
  export type ComputerUseRightClickAction = typeof ComputerUseRightClickAction.Type
@@ -1120,7 +1122,7 @@ export type ComputerUseRightClickAction = typeof ComputerUseRightClickAction.Typ
1120
1122
  * @see {@link ComputerUse_20250124} for the tool version that accepts this action
1121
1123
  * @see {@link ScrollDirection} for the accepted direction literals
1122
1124
  *
1123
- * @category Computer Use
1125
+ * @category computer use
1124
1126
  * @since 4.0.0
1125
1127
  */
1126
1128
  export const ComputerUseScrollAction = Schema.Struct({
@@ -1142,7 +1144,7 @@ export const ComputerUseScrollAction = Schema.Struct({
1142
1144
  /**
1143
1145
  * Computer-use action payload for scrolling by a specified amount in a specified direction, optionally from a coordinate.
1144
1146
  *
1145
- * @category Computer Use
1147
+ * @category computer use
1146
1148
  * @since 4.0.0
1147
1149
  */
1148
1150
  export type ComputerUseScrollAction = typeof ComputerUseScrollAction.Type
@@ -1169,7 +1171,7 @@ export type ComputerUseScrollAction = typeof ComputerUseScrollAction.Type
1169
1171
  * @see {@link ComputerUseDoubleClickAction} for the two-click variant
1170
1172
  * @see {@link ComputerUseLeftClickAction} for a single left click
1171
1173
  *
1172
- * @category Computer Use
1174
+ * @category computer use
1173
1175
  * @since 4.0.0
1174
1176
  */
1175
1177
  export const ComputerUseTripleClickAction = Schema.Struct({
@@ -1183,7 +1185,7 @@ export const ComputerUseTripleClickAction = Schema.Struct({
1183
1185
  /**
1184
1186
  * Computer-use action payload for performing a triple click, optionally at a specific coordinate.
1185
1187
  *
1186
- * @category Computer Use
1188
+ * @category computer use
1187
1189
  * @since 4.0.0
1188
1190
  */
1189
1191
  export type ComputerUseTripleClickAction = typeof ComputerUseTripleClickAction.Type
@@ -1209,7 +1211,7 @@ export type ComputerUseTripleClickAction = typeof ComputerUseTripleClickAction.T
1209
1211
  * @see {@link ComputerUseHoldKeyAction} for another duration-based computer-use action
1210
1212
  * @see {@link ComputerUse_20250124} for the tool version that accepts this action
1211
1213
  *
1212
- * @category Computer Use
1214
+ * @category computer use
1213
1215
  * @since 4.0.0
1214
1216
  */
1215
1217
  export const ComputerUseWaitAction = Schema.Struct({
@@ -1222,7 +1224,7 @@ export const ComputerUseWaitAction = Schema.Struct({
1222
1224
  /**
1223
1225
  * Computer-use action payload for pausing for a specified duration.
1224
1226
  *
1225
- * @category Computer Use
1227
+ * @category computer use
1226
1228
  * @since 4.0.0
1227
1229
  */
1228
1230
  export type ComputerUseWaitAction = typeof ComputerUseWaitAction.Type
@@ -1246,7 +1248,7 @@ const ComputerUse_20250124_Actions = Schema.Union([
1246
1248
  // -----------------------------------------------------------------------------
1247
1249
 
1248
1250
  /**
1249
- * Zoom into a specific region of the screen at full resolution.
1251
+ * Zooms into a specific region of the screen at full resolution.
1250
1252
  *
1251
1253
  * **Details**
1252
1254
  *
@@ -1260,7 +1262,7 @@ const ComputerUse_20250124_Actions = Schema.Union([
1260
1262
  * @see {@link ComputerUse_20251124} for the tool version that accepts this action
1261
1263
  * @see {@link ComputerUseScreenshotAction} for capturing the full screen instead
1262
1264
  *
1263
- * @category Computer Use
1265
+ * @category computer use
1264
1266
  * @since 4.0.0
1265
1267
  */
1266
1268
  export const ComputerUseZoomAction = Schema.Struct({
@@ -1280,7 +1282,7 @@ export const ComputerUseZoomAction = Schema.Struct({
1280
1282
  * `region` is only a four-number tuple and does not validate corner ordering or
1281
1283
  * display bounds.
1282
1284
  *
1283
- * @category Computer Use
1285
+ * @category computer use
1284
1286
  * @since 4.0.0
1285
1287
  */
1286
1288
  export type ComputerUseZoomAction = typeof ComputerUseZoomAction.Type
@@ -1295,14 +1297,14 @@ const ComputerUse_20251124_Actions = Schema.Union([
1295
1297
  // -----------------------------------------------------------------------------
1296
1298
 
1297
1299
  /**
1298
- * Computer use tool for Claude 3.5 Sonnet v2 (deprecated).
1300
+ * Defines the deprecated computer-use tool for Claude 3.5 Sonnet v2.
1299
1301
  *
1300
1302
  * **Details**
1301
1303
  *
1302
1304
  * Requires the "computer-use-2024-10-22" beta header.
1303
1305
  * Basic actions only: screenshot, left_click, type, key, mouse_move.
1304
1306
  *
1305
- * @category Computer Use
1307
+ * @category computer use
1306
1308
  * @since 4.0.0
1307
1309
  */
1308
1310
  export const ComputerUse_20241022 = Tool.providerDefined({
@@ -1316,7 +1318,7 @@ export const ComputerUse_20241022 = Tool.providerDefined({
1316
1318
  })
1317
1319
 
1318
1320
  /**
1319
- * Computer use tool for Claude 4 models and Claude Sonnet 3.7.
1321
+ * Defines the computer-use tool for Claude 4 models and Claude Sonnet 3.7.
1320
1322
  *
1321
1323
  * **When to use**
1322
1324
  *
@@ -1333,7 +1335,7 @@ export const ComputerUse_20241022 = Tool.providerDefined({
1333
1335
  * @see {@link ComputerUse_20241022} for the older basic action set
1334
1336
  * @see {@link ComputerUse_20251124} for the newer zoom-capable version
1335
1337
  *
1336
- * @category Computer Use
1338
+ * @category computer use
1337
1339
  * @since 4.0.0
1338
1340
  */
1339
1341
  export const ComputerUse_20250124 = Tool.providerDefined({
@@ -1347,7 +1349,7 @@ export const ComputerUse_20250124 = Tool.providerDefined({
1347
1349
  })
1348
1350
 
1349
1351
  /**
1350
- * Computer use tool for Claude Opus 4.5 only.
1352
+ * Defines the computer-use tool for Claude Opus 4.5 only.
1351
1353
  *
1352
1354
  * **When to use**
1353
1355
  *
@@ -1367,7 +1369,7 @@ export const ComputerUse_20250124 = Tool.providerDefined({
1367
1369
  * @see {@link ComputerUse_20250124} for the previous action set without zoom
1368
1370
  * @see {@link ComputerUseZoomAction} for the zoom action payload
1369
1371
  *
1370
- * @category Computer Use
1372
+ * @category computer use
1371
1373
  * @since 4.0.0
1372
1374
  */
1373
1375
  export const ComputerUse_20251124 = Tool.providerDefined({
@@ -1389,7 +1391,7 @@ export const ComputerUse_20251124 = Tool.providerDefined({
1389
1391
  // -----------------------------------------------------------------------------
1390
1392
 
1391
1393
  /**
1392
- * A `[start, end]` line range for viewing file contents.
1394
+ * Defines a `[start, end]` line range for viewing file contents.
1393
1395
  *
1394
1396
  * **When to use**
1395
1397
  *
@@ -1405,7 +1407,7 @@ export const ComputerUse_20251124 = Tool.providerDefined({
1405
1407
  * @see {@link MemoryViewCommand} for memory view payloads that use this range
1406
1408
  * @see {@link TextEditorViewCommand} for text editor view payloads that use this range
1407
1409
  *
1408
- * @category Memory
1410
+ * @category memory
1409
1411
  * @since 4.0.0
1410
1412
  */
1411
1413
  export const ViewRange = Schema.Tuple([Schema.Number, Schema.Number])
@@ -1416,7 +1418,7 @@ export const ViewRange = Schema.Tuple([Schema.Number, Schema.Number])
1416
1418
  *
1417
1419
  * Use when typing `view_range` for memory or text editor view commands.
1418
1420
  *
1419
- * @category Memory
1421
+ * @category memory
1420
1422
  * @since 4.0.0
1421
1423
  */
1422
1424
  export type ViewRange = typeof ViewRange.Type
@@ -1432,7 +1434,7 @@ export type ViewRange = typeof ViewRange.Type
1432
1434
  *
1433
1435
  * The payload contains `command: "create"` and a `path` string.
1434
1436
  *
1435
- * @category Memory
1437
+ * @category memory
1436
1438
  * @since 4.0.0
1437
1439
  */
1438
1440
  export const MemoryCreateCommand = Schema.Struct({
@@ -1445,7 +1447,7 @@ export const MemoryCreateCommand = Schema.Struct({
1445
1447
  /**
1446
1448
  * Memory tool command payload for creating a new file at a path.
1447
1449
  *
1448
- * @category Memory
1450
+ * @category memory
1449
1451
  * @since 4.0.0
1450
1452
  */
1451
1453
  export type MemoryCreateCommand = typeof MemoryCreateCommand.Type
@@ -1453,7 +1455,7 @@ export type MemoryCreateCommand = typeof MemoryCreateCommand.Type
1453
1455
  /**
1454
1456
  * Schema for a memory command that deletes a file or directory.
1455
1457
  *
1456
- * @category Memory
1458
+ * @category memory
1457
1459
  * @since 4.0.0
1458
1460
  */
1459
1461
  export const MemoryDeleteCommand = Schema.Struct({
@@ -1466,7 +1468,7 @@ export const MemoryDeleteCommand = Schema.Struct({
1466
1468
  /**
1467
1469
  * Memory tool command payload for deleting a file or directory at a path.
1468
1470
  *
1469
- * @category Memory
1471
+ * @category memory
1470
1472
  * @since 4.0.0
1471
1473
  */
1472
1474
  export type MemoryDeleteCommand = typeof MemoryDeleteCommand.Type
@@ -1486,7 +1488,7 @@ export type MemoryDeleteCommand = typeof MemoryDeleteCommand.Type
1486
1488
  * @see {@link Memory_20250818} for the provider-defined tool that consumes this command
1487
1489
  * @see {@link MemoryStrReplaceCommand} for replacing existing text instead
1488
1490
  *
1489
- * @category Memory
1491
+ * @category memory
1490
1492
  * @since 4.0.0
1491
1493
  */
1492
1494
  export const MemoryInsertCommand = Schema.Struct({
@@ -1507,7 +1509,7 @@ export const MemoryInsertCommand = Schema.Struct({
1507
1509
  /**
1508
1510
  * Memory tool command payload for inserting text at a specific line in a file.
1509
1511
  *
1510
- * @category Memory
1512
+ * @category memory
1511
1513
  * @since 4.0.0
1512
1514
  */
1513
1515
  export type MemoryInsertCommand = typeof MemoryInsertCommand.Type
@@ -1520,7 +1522,7 @@ export type MemoryInsertCommand = typeof MemoryInsertCommand.Type
1520
1522
  * The payload uses `command: "rename"` and requires `old_path` as the current
1521
1523
  * path plus `new_path` as the new destination path.
1522
1524
  *
1523
- * @category Memory
1525
+ * @category memory
1524
1526
  * @since 4.0.0
1525
1527
  */
1526
1528
  export const MemoryRenameCommand = Schema.Struct({
@@ -1537,7 +1539,7 @@ export const MemoryRenameCommand = Schema.Struct({
1537
1539
  /**
1538
1540
  * Memory tool command payload for renaming or moving a file or directory.
1539
1541
  *
1540
- * @category Memory
1542
+ * @category memory
1541
1543
  * @since 4.0.0
1542
1544
  */
1543
1545
  export type MemoryRenameCommand = typeof MemoryRenameCommand.Type
@@ -1557,7 +1559,7 @@ export type MemoryRenameCommand = typeof MemoryRenameCommand.Type
1557
1559
  *
1558
1560
  * @see {@link Memory_20250818} for the provider-defined tool that consumes this command
1559
1561
  *
1560
- * @category Memory
1562
+ * @category memory
1561
1563
  * @since 4.0.0
1562
1564
  */
1563
1565
  export const MemoryStrReplaceCommand = Schema.Struct({
@@ -1578,7 +1580,7 @@ export const MemoryStrReplaceCommand = Schema.Struct({
1578
1580
  /**
1579
1581
  * Memory tool command payload for replacing text in a file.
1580
1582
  *
1581
- * @category Memory
1583
+ * @category memory
1582
1584
  * @since 4.0.0
1583
1585
  */
1584
1586
  export type MemoryStrReplaceCommand = typeof MemoryStrReplaceCommand.Type
@@ -1591,7 +1593,7 @@ export type MemoryStrReplaceCommand = typeof MemoryStrReplaceCommand.Type
1591
1593
  * When used on a file, returns file contents optionally limited by `view_range`.
1592
1594
  * When used on a directory, lists contents.
1593
1595
  *
1594
- * @category Memory
1596
+ * @category memory
1595
1597
  * @since 4.0.0
1596
1598
  */
1597
1599
  export const MemoryViewCommand = Schema.Struct({
@@ -1608,7 +1610,7 @@ export const MemoryViewCommand = Schema.Struct({
1608
1610
  /**
1609
1611
  * Memory tool command payload for viewing a file or directory, optionally with a file line range.
1610
1612
  *
1611
- * @category Memory
1613
+ * @category memory
1612
1614
  * @since 4.0.0
1613
1615
  */
1614
1616
  export type MemoryViewCommand = typeof MemoryViewCommand.Type
@@ -1627,14 +1629,14 @@ const Memory_20250818_Commands = Schema.Union([
1627
1629
  // -----------------------------------------------------------------------------
1628
1630
 
1629
1631
  /**
1630
- * Memory tool for persistent file operations across conversations.
1632
+ * Defines the memory tool for persistent file operations across conversations.
1631
1633
  *
1632
1634
  * **Details**
1633
1635
  *
1634
1636
  * Provides commands for creating, viewing, editing, renaming, and deleting
1635
1637
  * files within the model's memory space.
1636
1638
  *
1637
- * @category Memory
1639
+ * @category memory
1638
1640
  * @since 4.0.0
1639
1641
  */
1640
1642
  export const Memory_20250818 = Tool.providerDefined({
@@ -1654,7 +1656,7 @@ export const Memory_20250818 = Tool.providerDefined({
1654
1656
  // -----------------------------------------------------------------------------
1655
1657
 
1656
1658
  /**
1657
- * View the contents of a file or list directory contents.
1659
+ * Reads the contents of a file or lists directory contents.
1658
1660
  *
1659
1661
  * **When to use**
1660
1662
  *
@@ -1670,7 +1672,7 @@ export const Memory_20250818 = Tool.providerDefined({
1670
1672
  *
1671
1673
  * @see {@link CodeExecutionTextEditorView} for the code-execution variant without `view_range`
1672
1674
  *
1673
- * @category Text Editor
1675
+ * @category text editor
1674
1676
  * @since 4.0.0
1675
1677
  */
1676
1678
  export const TextEditorViewCommand = Schema.Struct({
@@ -1693,7 +1695,7 @@ export const TextEditorViewCommand = Schema.Struct({
1693
1695
  * `view_range` is a 1-indexed `[start, end]` tuple where `-1` means through
1694
1696
  * the end of the file.
1695
1697
  *
1696
- * @category Text Editor
1698
+ * @category text editor
1697
1699
  * @since 4.0.0
1698
1700
  */
1699
1701
  export type TextEditorViewCommand = typeof TextEditorViewCommand.Type
@@ -1715,7 +1717,7 @@ export type TextEditorViewCommand = typeof TextEditorViewCommand.Type
1715
1717
  *
1716
1718
  * Fails if the file already exists. Parent directories must exist.
1717
1719
  *
1718
- * @category Text Editor
1720
+ * @category text editor
1719
1721
  * @since 4.0.0
1720
1722
  */
1721
1723
  export const TextEditorCreateCommand = Schema.Struct({
@@ -1736,13 +1738,13 @@ export const TextEditorCreateCommand = Schema.Struct({
1736
1738
  *
1737
1739
  * The command fails if the file already exists or if parent directories are missing.
1738
1740
  *
1739
- * @category Text Editor
1741
+ * @category text editor
1740
1742
  * @since 4.0.0
1741
1743
  */
1742
1744
  export type TextEditorCreateCommand = typeof TextEditorCreateCommand.Type
1743
1745
 
1744
1746
  /**
1745
- * Replace a specific string in a file with a new string.
1747
+ * Replaces a specific string in a file with a new string.
1746
1748
  *
1747
1749
  * **When to use**
1748
1750
  *
@@ -1762,7 +1764,7 @@ export type TextEditorCreateCommand = typeof TextEditorCreateCommand.Type
1762
1764
  * @see {@link TextEditorViewCommand} for reading contents before choosing `old_str`
1763
1765
  * @see {@link CodeExecutionTextEditorStrReplace} for the code-execution variant
1764
1766
  *
1765
- * @category Text Editor
1767
+ * @category text editor
1766
1768
  * @since 4.0.0
1767
1769
  */
1768
1770
  export const TextEditorStrReplaceCommand = Schema.Struct({
@@ -1788,20 +1790,20 @@ export const TextEditorStrReplaceCommand = Schema.Struct({
1788
1790
  * The `old_str` must match exactly, including whitespace and indentation, and
1789
1791
  * must be unique in the file.
1790
1792
  *
1791
- * @category Text Editor
1793
+ * @category text editor
1792
1794
  * @since 4.0.0
1793
1795
  */
1794
1796
  export type TextEditorStrReplaceCommand = typeof TextEditorStrReplaceCommand.Type
1795
1797
 
1796
1798
  /**
1797
- * Insert text at a specific line number in a file.
1799
+ * Inserts text at a specific line number in a file.
1798
1800
  *
1799
1801
  * **Details**
1800
1802
  *
1801
1803
  * Inserts the new text after the specified line number. Use `0` to insert at
1802
1804
  * the beginning of the file; other values are 1-indexed.
1803
1805
  *
1804
- * @category Text Editor
1806
+ * @category text editor
1805
1807
  * @since 4.0.0
1806
1808
  */
1807
1809
  export const TextEditorInsertCommand = Schema.Struct({
@@ -1822,13 +1824,13 @@ export const TextEditorInsertCommand = Schema.Struct({
1822
1824
  /**
1823
1825
  * Text editor command payload for inserting text after a specific line number in a file.
1824
1826
  *
1825
- * @category Text Editor
1827
+ * @category text editor
1826
1828
  * @since 4.0.0
1827
1829
  */
1828
1830
  export type TextEditorInsertCommand = typeof TextEditorInsertCommand.Type
1829
1831
 
1830
1832
  /**
1831
- * Undo the last edit made to a file.
1833
+ * Undoes the last edit made to a file.
1832
1834
  *
1833
1835
  * **Details**
1834
1836
  *
@@ -1841,7 +1843,7 @@ export type TextEditorInsertCommand = typeof TextEditorInsertCommand.Type
1841
1843
  * `text_editor_20250124`, but not in `text_editor_20250429` or
1842
1844
  * `text_editor_20250728`.
1843
1845
  *
1844
- * @category Text Editor
1846
+ * @category text editor
1845
1847
  * @since 4.0.0
1846
1848
  */
1847
1849
  export const TextEditorUndoEditCommand = Schema.Struct({
@@ -1859,7 +1861,7 @@ export const TextEditorUndoEditCommand = Schema.Struct({
1859
1861
  * Available for `text_editor_20241022` and `text_editor_20250124`, but not for
1860
1862
  * `text_editor_20250429` or `text_editor_20250728`.
1861
1863
  *
1862
- * @category Text Editor
1864
+ * @category text editor
1863
1865
  * @since 4.0.0
1864
1866
  */
1865
1867
  export type TextEditorUndoEditCommand = typeof TextEditorUndoEditCommand.Type
@@ -1896,7 +1898,7 @@ const TextEditor_StrReplaceBasedEdit_Args = Schema.Struct({
1896
1898
  // -----------------------------------------------------------------------------
1897
1899
 
1898
1900
  /**
1899
- * Text editor tool for Claude 3.5 Sonnet (deprecated).
1901
+ * Defines the deprecated text editor tool for Claude 3.5 Sonnet.
1900
1902
  *
1901
1903
  * **When to use**
1902
1904
  *
@@ -1911,7 +1913,7 @@ const TextEditor_StrReplaceBasedEdit_Args = Schema.Struct({
1911
1913
  * @see {@link TextEditor_20250124} for the newer `str_replace_editor` version
1912
1914
  * @see {@link TextEditor_20250728} for the Claude 4 `str_replace_based_edit_tool` line
1913
1915
  *
1914
- * @category Text Editor
1916
+ * @category text editor
1915
1917
  * @since 4.0.0
1916
1918
  */
1917
1919
  export const TextEditor_20241022 = Tool.providerDefined({
@@ -1924,7 +1926,7 @@ export const TextEditor_20241022 = Tool.providerDefined({
1924
1926
  })
1925
1927
 
1926
1928
  /**
1927
- * Text editor tool for Claude Sonnet 3.7 (deprecated model).
1929
+ * Defines the text editor tool for deprecated Claude Sonnet 3.7.
1928
1930
  *
1929
1931
  * **When to use**
1930
1932
  *
@@ -1939,7 +1941,7 @@ export const TextEditor_20241022 = Tool.providerDefined({
1939
1941
  * @see {@link TextEditor_20241022} for the older `str_replace_editor` version
1940
1942
  * @see {@link TextEditor_20250429} for the Claude 4 `str_replace_based_edit_tool` line
1941
1943
  *
1942
- * @category Text Editor
1944
+ * @category text editor
1943
1945
  * @since 4.0.0
1944
1946
  */
1945
1947
  export const TextEditor_20250124 = Tool.providerDefined({
@@ -1952,7 +1954,7 @@ export const TextEditor_20250124 = Tool.providerDefined({
1952
1954
  })
1953
1955
 
1954
1956
  /**
1955
- * Text editor tool for Claude 4 models using Anthropic's `str_replace_based_edit_tool`.
1957
+ * Defines the text editor tool for Claude 4 models using Anthropic's `str_replace_based_edit_tool`.
1956
1958
  *
1957
1959
  * **When to use**
1958
1960
  *
@@ -1970,7 +1972,7 @@ export const TextEditor_20250124 = Tool.providerDefined({
1970
1972
  * @see {@link TextEditor_20250124} for the previous `str_replace_editor` version
1971
1973
  * @see {@link TextEditor_20250728} for the later Claude 4 text editor version
1972
1974
  *
1973
- * @category Text Editor
1975
+ * @category text editor
1974
1976
  * @since 4.0.0
1975
1977
  */
1976
1978
  export const TextEditor_20250429 = Tool.providerDefined({
@@ -1984,7 +1986,7 @@ export const TextEditor_20250429 = Tool.providerDefined({
1984
1986
  })
1985
1987
 
1986
1988
  /**
1987
- * Text editor tool for Claude 4 models.
1989
+ * Defines the text editor tool for Claude 4 models.
1988
1990
  *
1989
1991
  * **Details**
1990
1992
  *
@@ -1995,7 +1997,7 @@ export const TextEditor_20250429 = Tool.providerDefined({
1995
1997
  *
1996
1998
  * This version does not support the `undo_edit` command.
1997
1999
  *
1998
- * @category Text Editor
2000
+ * @category text editor
1999
2001
  * @since 4.0.0
2000
2002
  */
2001
2003
  export const TextEditor_20250728 = Tool.providerDefined({
@@ -2017,7 +2019,7 @@ export const TextEditor_20250728 = Tool.providerDefined({
2017
2019
  // -----------------------------------------------------------------------------
2018
2020
 
2019
2021
  /**
2020
- * User location for localizing search results.
2022
+ * Describes user location for localizing search results.
2021
2023
  *
2022
2024
  * **When to use**
2023
2025
  *
@@ -2063,7 +2065,7 @@ export const WebSearchUserLocation = Schema.Struct({
2063
2065
  // -----------------------------------------------------------------------------
2064
2066
 
2065
2067
  /**
2066
- * Configuration arguments for the web search tool.
2068
+ * Defines configuration arguments for the web search tool.
2067
2069
  *
2068
2070
  * **When to use**
2069
2071
  *
@@ -2161,7 +2163,7 @@ export type WebSearchParameters = typeof WebSearchParameters.Type
2161
2163
  // -----------------------------------------------------------------------------
2162
2164
 
2163
2165
  /**
2164
- * Web search tool for Claude models.
2166
+ * Defines the web search tool for Claude models.
2165
2167
  *
2166
2168
  * **When to use**
2167
2169
  *
@@ -2197,7 +2199,7 @@ export const WebSearch_20250305 = Tool.providerDefined({
2197
2199
  // -----------------------------------------------------------------------------
2198
2200
 
2199
2201
  /**
2200
- * Citation configuration for web fetch.
2202
+ * Defines citation configuration for web fetch.
2201
2203
  *
2202
2204
  * **When to use**
2203
2205
  *
@@ -2239,7 +2241,7 @@ export type WebFetchCitationsConfig = typeof WebFetchCitationsConfig.Type
2239
2241
  // -----------------------------------------------------------------------------
2240
2242
 
2241
2243
  /**
2242
- * Configuration arguments for the web fetch tool.
2244
+ * Defines configuration arguments for the web fetch tool.
2243
2245
  *
2244
2246
  * **When to use**
2245
2247
  *
@@ -2358,7 +2360,7 @@ export type WebFetchParameters = typeof WebFetchParameters.Type
2358
2360
  // -----------------------------------------------------------------------------
2359
2361
 
2360
2362
  /**
2361
- * Web fetch tool for Claude models.
2363
+ * Defines the web fetch tool for Claude models.
2362
2364
  *
2363
2365
  * **When to use**
2364
2366
  *
@@ -2394,14 +2396,14 @@ export const WebFetch_20250910 = Tool.providerDefined({
2394
2396
  // -----------------------------------------------------------------------------
2395
2397
 
2396
2398
  /**
2397
- * Input parameters for regex-based tool search.
2399
+ * Schema for regex-based tool search input parameters.
2398
2400
  *
2399
2401
  * **Details**
2400
2402
  *
2401
2403
  * Claude constructs regex patterns using Python's `re.search()` syntax.
2402
2404
  * Maximum query length: 200 characters.
2403
2405
  *
2404
- * @category Tool Search
2406
+ * @category tool search
2405
2407
  * @since 4.0.0
2406
2408
  */
2407
2409
  export const ToolSearchRegexParameters = Schema.Struct({
@@ -2418,13 +2420,13 @@ export const ToolSearchRegexParameters = Schema.Struct({
2418
2420
  * Claude constructs regex patterns using Python's `re.search()` syntax.
2419
2421
  * Maximum query length: 200 characters.
2420
2422
  *
2421
- * @category Tool Search
2423
+ * @category tool search
2422
2424
  * @since 4.0.0
2423
2425
  */
2424
2426
  export type ToolSearchRegexParameters = typeof ToolSearchRegexParameters.Type
2425
2427
 
2426
2428
  /**
2427
- * Input parameters for BM25/natural language tool search.
2429
+ * Defines input parameters for BM25/natural language tool search.
2428
2430
  *
2429
2431
  * **When to use**
2430
2432
  *
@@ -2438,7 +2440,7 @@ export type ToolSearchRegexParameters = typeof ToolSearchRegexParameters.Type
2438
2440
  *
2439
2441
  * @see {@link ToolSearchBM25_20251119} for the provider-defined tool that consumes these parameters
2440
2442
  *
2441
- * @category Tool Search
2443
+ * @category tool search
2442
2444
  * @since 4.0.0
2443
2445
  */
2444
2446
  export const ToolSearchBM25Parameters = Schema.Struct({
@@ -2450,7 +2452,7 @@ export const ToolSearchBM25Parameters = Schema.Struct({
2450
2452
  /**
2451
2453
  * Type of the parameters Claude supplies when invoking BM25 natural-language Anthropic tool search.
2452
2454
  *
2453
- * @category Tool Search
2455
+ * @category tool search
2454
2456
  * @since 4.0.0
2455
2457
  */
2456
2458
  export type ToolSearchBM25Parameters = typeof ToolSearchBM25Parameters.Type
@@ -2460,7 +2462,7 @@ export type ToolSearchBM25Parameters = typeof ToolSearchBM25Parameters.Type
2460
2462
  // -----------------------------------------------------------------------------
2461
2463
 
2462
2464
  /**
2463
- * Regex-based tool search for Claude models.
2465
+ * Defines regex-based tool search for Claude models.
2464
2466
  *
2465
2467
  * **Details**
2466
2468
  *
@@ -2469,7 +2471,7 @@ export type ToolSearchBM25Parameters = typeof ToolSearchBM25Parameters.Type
2469
2471
  * argument names, and argument descriptions.
2470
2472
  * Requires the "advanced-tool-use-2025-11-20" beta header.
2471
2473
  *
2472
- * @category Tool Search
2474
+ * @category tool search
2473
2475
  * @since 4.0.0
2474
2476
  */
2475
2477
  export const ToolSearchRegex_20251119 = Tool.providerDefined({
@@ -2482,7 +2484,7 @@ export const ToolSearchRegex_20251119 = Tool.providerDefined({
2482
2484
  })
2483
2485
 
2484
2486
  /**
2485
- * BM25/natural language tool search for Claude models.
2487
+ * Defines BM25/natural language tool search for Claude models.
2486
2488
  *
2487
2489
  * **When to use**
2488
2490
  *
@@ -2498,7 +2500,7 @@ export const ToolSearchRegex_20251119 = Tool.providerDefined({
2498
2500
  *
2499
2501
  * @see {@link ToolSearchRegex_20251119} for the regex-pattern alternative
2500
2502
  *
2501
- * @category Tool Search
2503
+ * @category tool search
2502
2504
  * @since 4.0.0
2503
2505
  */
2504
2506
  export const ToolSearchBM25_20251119 = Tool.providerDefined({