-
Notifications
You must be signed in to change notification settings - Fork 1.7k
Expand file tree
/
Copy pathsdk-tools.d.ts
More file actions
2719 lines (2717 loc) · 114 KB
/
sdk-tools.d.ts
File metadata and controls
2719 lines (2717 loc) · 114 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* eslint-disable */
/**
* This file was automatically generated by json-schema-to-typescript.
* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
* and run json-schema-to-typescript to regenerate this file.
*/
/**
* JSON Schema definitions for Claude CLI tool inputs
*/
export type ToolInputSchemas =
| AgentInput
| BashInput
| TaskOutputInput
| ExitPlanModeInput
| FileEditInput
| FileReadInput
| FileWriteInput
| GlobInput
| GrepInput
| TaskStopInput
| ListMcpResourcesInput
| McpInput
| NotebookEditInput
| ReadMcpResourceInput
| TodoWriteInput
| WebFetchInput
| WebSearchInput
| AskUserQuestionInput
| ConfigInput
| EnterWorktreeInput
| ExitWorktreeInput
| ToolOutputSchemas;
export type ToolOutputSchemas =
| AgentOutput
| BashOutput
| ExitPlanModeOutput
| FileEditOutput
| FileReadOutput
| FileWriteOutput
| GlobOutput
| GrepOutput
| TaskStopOutput
| ListMcpResourcesOutput
| McpOutput
| NotebookEditOutput
| ReadMcpResourceOutput
| TodoWriteOutput
| WebFetchOutput
| WebSearchOutput
| AskUserQuestionOutput
| ConfigOutput
| EnterWorktreeOutput
| ExitWorktreeOutput;
export type AgentOutput =
| {
agentId: string;
agentType?: string;
content: {
type: "text";
text: string;
}[];
totalToolUseCount: number;
totalDurationMs: number;
totalTokens: number;
usage: {
input_tokens: number;
output_tokens: number;
cache_creation_input_tokens: number | null;
cache_read_input_tokens: number | null;
server_tool_use: {
web_search_requests: number;
web_fetch_requests: number;
} | null;
service_tier: ("standard" | "priority" | "batch") | null;
cache_creation: {
ephemeral_1h_input_tokens: number;
ephemeral_5m_input_tokens: number;
} | null;
};
status: "completed";
prompt: string;
}
| {
status: "async_launched";
/**
* The ID of the async agent
*/
agentId: string;
/**
* The description of the task
*/
description: string;
/**
* The prompt for the agent
*/
prompt: string;
/**
* Path to the output file for checking agent progress
*/
outputFile: string;
/**
* Whether the calling agent has Read/Bash tools to check progress
*/
canReadOutputFile?: boolean;
};
export type FileReadOutput =
| {
type: "text";
file: {
/**
* The path to the file that was read
*/
filePath: string;
/**
* The content of the file
*/
content: string;
/**
* Number of lines in the returned content
*/
numLines: number;
/**
* The starting line number
*/
startLine: number;
/**
* Total number of lines in the file
*/
totalLines: number;
};
}
| {
type: "image";
file: {
/**
* Base64-encoded image data
*/
base64: string;
/**
* The MIME type of the image
*/
type: "image/jpeg" | "image/png" | "image/gif" | "image/webp";
/**
* Original file size in bytes
*/
originalSize: number;
/**
* Image dimension info for coordinate mapping
*/
dimensions?: {
/**
* Original image width in pixels
*/
originalWidth?: number;
/**
* Original image height in pixels
*/
originalHeight?: number;
/**
* Displayed image width in pixels (after resizing)
*/
displayWidth?: number;
/**
* Displayed image height in pixels (after resizing)
*/
displayHeight?: number;
};
};
}
| {
type: "notebook";
file: {
/**
* The path to the notebook file
*/
filePath: string;
/**
* Array of notebook cells
*/
cells: unknown[];
};
}
| {
type: "pdf";
file: {
/**
* The path to the PDF file
*/
filePath: string;
/**
* Base64-encoded PDF data
*/
base64: string;
/**
* Original file size in bytes
*/
originalSize: number;
};
}
| {
type: "parts";
file: {
/**
* The path to the PDF file
*/
filePath: string;
/**
* Original file size in bytes
*/
originalSize: number;
/**
* Number of pages extracted
*/
count: number;
/**
* Directory containing extracted page images
*/
outputDir: string;
};
}
| {
type: "file_unchanged";
file: {
/**
* The path to the file
*/
filePath: string;
};
};
export type ListMcpResourcesOutput = {
/**
* Resource URI
*/
uri: string;
/**
* Resource name
*/
name: string;
/**
* MIME type of the resource
*/
mimeType?: string;
/**
* Resource description
*/
description?: string;
/**
* Server that provides this resource
*/
server: string;
}[];
/**
* MCP tool execution result
*/
export type McpOutput = string;
export interface AgentInput {
/**
* A short (3-5 word) description of the task
*/
description: string;
/**
* The task for the agent to perform
*/
prompt: string;
/**
* The type of specialized agent to use for this task
*/
subagent_type?: string;
/**
* Optional model override for this agent. Takes precedence over the agent definition's model frontmatter. If omitted, uses the agent definition's model, or inherits from the parent.
*/
model?: "sonnet" | "opus" | "haiku";
/**
* Set to true to run this agent in the background. You will be notified when it completes.
*/
run_in_background?: boolean;
/**
* Name for the spawned agent. Makes it addressable via SendMessage({to: name}) while running.
*/
name?: string;
/**
* Team name for spawning. Uses current team context if omitted.
*/
team_name?: string;
/**
* Permission mode for spawned teammate (e.g., "plan" to require plan approval).
*/
mode?: "acceptEdits" | "bypassPermissions" | "default" | "dontAsk" | "plan";
/**
* Isolation mode. "worktree" creates a temporary git worktree so the agent works on an isolated copy of the repo.
*/
isolation?: "worktree";
}
export interface BashInput {
/**
* The command to execute
*/
command: string;
/**
* Optional timeout in milliseconds (max 600000)
*/
timeout?: number;
/**
* Clear, concise description of what this command does in active voice. Never use words like "complex" or "risk" in the description - just describe what it does.
*
* For simple commands (git, npm, standard CLI tools), keep it brief (5-10 words):
* - ls → "List files in current directory"
* - git status → "Show working tree status"
* - npm install → "Install package dependencies"
*
* For commands that are harder to parse at a glance (piped commands, obscure flags, etc.), add enough context to clarify what it does:
* - find . -name "*.tmp" -exec rm {} \; → "Find and delete all .tmp files recursively"
* - git reset --hard origin/main → "Discard all local changes and match remote main"
* - curl -s url | jq '.data[]' → "Fetch JSON from URL and extract data array elements"
*/
description?: string;
/**
* Set to true to run this command in the background. Use Read to read the output later.
*/
run_in_background?: boolean;
/**
* Set this to true to dangerously override sandbox mode and run commands without sandboxing.
*/
dangerouslyDisableSandbox?: boolean;
}
export interface TaskOutputInput {
/**
* The task ID to get output from
*/
task_id: string;
/**
* Whether to wait for completion
*/
block: boolean;
/**
* Max wait time in ms
*/
timeout: number;
}
export interface ExitPlanModeInput {
/**
* Prompt-based permissions needed to implement the plan. These describe categories of actions rather than specific commands.
*/
allowedPrompts?: {
/**
* The tool this prompt applies to
*/
tool: "Bash";
/**
* Semantic description of the action, e.g. "run tests", "install dependencies"
*/
prompt: string;
}[];
[k: string]: unknown;
}
export interface FileEditInput {
/**
* The absolute path to the file to modify
*/
file_path: string;
/**
* The text to replace
*/
old_string: string;
/**
* The text to replace it with (must be different from old_string)
*/
new_string: string;
/**
* Replace all occurrences of old_string (default false)
*/
replace_all?: boolean;
}
export interface FileReadInput {
/**
* The absolute path to the file to read
*/
file_path: string;
/**
* The line number to start reading from. Only provide if the file is too large to read at once
*/
offset?: number;
/**
* The number of lines to read. Only provide if the file is too large to read at once.
*/
limit?: number;
/**
* Page range for PDF files (e.g., "1-5", "3", "10-20"). Only applicable to PDF files. Maximum 20 pages per request.
*/
pages?: string;
}
export interface FileWriteInput {
/**
* The absolute path to the file to write (must be absolute, not relative)
*/
file_path: string;
/**
* The content to write to the file
*/
content: string;
}
export interface GlobInput {
/**
* The glob pattern to match files against
*/
pattern: string;
/**
* The directory to search in. If not specified, the current working directory will be used. IMPORTANT: Omit this field to use the default directory. DO NOT enter "undefined" or "null" - simply omit it for the default behavior. Must be a valid directory path if provided.
*/
path?: string;
}
export interface GrepInput {
/**
* The regular expression pattern to search for in file contents
*/
pattern: string;
/**
* File or directory to search in (rg PATH). Defaults to current working directory.
*/
path?: string;
/**
* Glob pattern to filter files (e.g. "*.js", "*.{ts,tsx}") - maps to rg --glob
*/
glob?: string;
/**
* Output mode: "content" shows matching lines (supports -A/-B/-C context, -n line numbers, head_limit), "files_with_matches" shows file paths (supports head_limit), "count" shows match counts (supports head_limit). Defaults to "files_with_matches".
*/
output_mode?: "content" | "files_with_matches" | "count";
/**
* Number of lines to show before each match (rg -B). Requires output_mode: "content", ignored otherwise.
*/
"-B"?: number;
/**
* Number of lines to show after each match (rg -A). Requires output_mode: "content", ignored otherwise.
*/
"-A"?: number;
/**
* Alias for context.
*/
"-C"?: number;
/**
* Number of lines to show before and after each match (rg -C). Requires output_mode: "content", ignored otherwise.
*/
context?: number;
/**
* Show line numbers in output (rg -n). Requires output_mode: "content", ignored otherwise. Defaults to true.
*/
"-n"?: boolean;
/**
* Case insensitive search (rg -i)
*/
"-i"?: boolean;
/**
* File type to search (rg --type). Common types: js, py, rust, go, java, etc. More efficient than include for standard file types.
*/
type?: string;
/**
* Limit output to first N lines/entries, equivalent to "| head -N". Works across all output modes: content (limits output lines), files_with_matches (limits file paths), count (limits count entries). Defaults to 250 when unspecified. Pass 0 for unlimited (use sparingly — large result sets waste context).
*/
head_limit?: number;
/**
* Skip first N lines/entries before applying head_limit, equivalent to "| tail -n +N | head -N". Works across all output modes. Defaults to 0.
*/
offset?: number;
/**
* Enable multiline mode where . matches newlines and patterns can span lines (rg -U --multiline-dotall). Default: false.
*/
multiline?: boolean;
}
export interface TaskStopInput {
/**
* The ID of the background task to stop
*/
task_id?: string;
/**
* Deprecated: use task_id instead
*/
shell_id?: string;
}
export interface ListMcpResourcesInput {
/**
* Optional server name to filter resources by
*/
server?: string;
}
export interface McpInput {
[k: string]: unknown;
}
export interface NotebookEditInput {
/**
* The absolute path to the Jupyter notebook file to edit (must be absolute, not relative)
*/
notebook_path: string;
/**
* The ID of the cell to edit. When inserting a new cell, the new cell will be inserted after the cell with this ID, or at the beginning if not specified.
*/
cell_id?: string;
/**
* The new source for the cell
*/
new_source: string;
/**
* The type of the cell (code or markdown). If not specified, it defaults to the current cell type. If using edit_mode=insert, this is required.
*/
cell_type?: "code" | "markdown";
/**
* The type of edit to make (replace, insert, delete). Defaults to replace.
*/
edit_mode?: "replace" | "insert" | "delete";
}
export interface ReadMcpResourceInput {
/**
* The MCP server name
*/
server: string;
/**
* The resource URI to read
*/
uri: string;
}
export interface TodoWriteInput {
/**
* The updated todo list
*/
todos: {
content: string;
status: "pending" | "in_progress" | "completed";
activeForm: string;
}[];
}
export interface WebFetchInput {
/**
* The URL to fetch content from
*/
url: string;
/**
* The prompt to run on the fetched content
*/
prompt: string;
}
export interface WebSearchInput {
/**
* The search query to use
*/
query: string;
/**
* Only include search results from these domains
*/
allowed_domains?: string[];
/**
* Never include search results from these domains
*/
blocked_domains?: string[];
}
export interface AskUserQuestionInput {
/**
* Questions to ask the user (1-4 questions)
*
* @minItems 1
* @maxItems 4
*/
questions:
| [
{
/**
* The complete question to ask the user. Should be clear, specific, and end with a question mark. Example: "Which library should we use for date formatting?" If multiSelect is true, phrase it accordingly, e.g. "Which features do you want to enable?"
*/
question: string;
/**
* Very short label displayed as a chip/tag (max 12 chars). Examples: "Auth method", "Library", "Approach".
*/
header: string;
/**
* The available choices for this question. Must have 2-4 options. Each option should be a distinct, mutually exclusive choice (unless multiSelect is enabled). There should be no 'Other' option, that will be provided automatically.
*
* @minItems 2
* @maxItems 4
*/
options:
| [
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
},
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
}
]
| [
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
},
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
},
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
}
]
| [
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
},
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
},
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
},
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
}
];
/**
* Set to true to allow the user to select multiple options instead of just one. Use when choices are not mutually exclusive.
*/
multiSelect: boolean;
}
]
| [
{
/**
* The complete question to ask the user. Should be clear, specific, and end with a question mark. Example: "Which library should we use for date formatting?" If multiSelect is true, phrase it accordingly, e.g. "Which features do you want to enable?"
*/
question: string;
/**
* Very short label displayed as a chip/tag (max 12 chars). Examples: "Auth method", "Library", "Approach".
*/
header: string;
/**
* The available choices for this question. Must have 2-4 options. Each option should be a distinct, mutually exclusive choice (unless multiSelect is enabled). There should be no 'Other' option, that will be provided automatically.
*
* @minItems 2
* @maxItems 4
*/
options:
| [
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
},
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
}
]
| [
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
},
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
},
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
}
]
| [
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
},
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
},
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
},
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
}
];
/**
* Set to true to allow the user to select multiple options instead of just one. Use when choices are not mutually exclusive.
*/
multiSelect: boolean;
},
{
/**
* The complete question to ask the user. Should be clear, specific, and end with a question mark. Example: "Which library should we use for date formatting?" If multiSelect is true, phrase it accordingly, e.g. "Which features do you want to enable?"
*/
question: string;
/**
* Very short label displayed as a chip/tag (max 12 chars). Examples: "Auth method", "Library", "Approach".
*/
header: string;
/**
* The available choices for this question. Must have 2-4 options. Each option should be a distinct, mutually exclusive choice (unless multiSelect is enabled). There should be no 'Other' option, that will be provided automatically.
*
* @minItems 2
* @maxItems 4
*/
options:
| [
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
},
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
}
]
| [
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
},
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
},
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
}
]
| [
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
},
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
},
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/