@go-hare/claude-agent-sdk 0.3.177

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.
package/sdk-tools.d.ts ADDED
@@ -0,0 +1,3324 @@
1
+ /* eslint-disable */
2
+ /**
3
+ * This file was automatically generated by json-schema-to-typescript.
4
+ * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
5
+ * and run json-schema-to-typescript to regenerate this file.
6
+ */
7
+
8
+ /**
9
+ * JSON Schema definitions for Claude CLI tool inputs
10
+ */
11
+ export type ToolInputSchemas =
12
+ | AgentInput
13
+ | BashInput
14
+ | TaskOutputInput
15
+ | ExitPlanModeInput
16
+ | FileEditInput
17
+ | FileReadInput
18
+ | FileWriteInput
19
+ | GlobInput
20
+ | GrepInput
21
+ | TaskStopInput
22
+ | ListMcpResourcesInput
23
+ | McpInput
24
+ | NotebookEditInput
25
+ | ReadMcpResourceInput
26
+ | TodoWriteInput
27
+ | WebFetchInput
28
+ | WebSearchInput
29
+ | AskUserQuestionInput
30
+ | ProjectsInput
31
+ | EnterPlanModeInput
32
+ | TaskCreateInput
33
+ | TaskGetInput
34
+ | TaskUpdateInput
35
+ | TaskListInput
36
+ | REPLInput
37
+ | WorkflowInput
38
+ | CronCreateInput
39
+ | CronDeleteInput
40
+ | CronListInput
41
+ | ScheduleWakeupInput
42
+ | RemoteTriggerInput
43
+ | ShowOnboardingRolePickerInput
44
+ | MonitorInput
45
+ | ArtifactInput
46
+ | PushNotificationInput
47
+ | EnterWorktreeInput
48
+ | ExitWorktreeInput
49
+ | ToolOutputSchemas;
50
+ export type ToolOutputSchemas =
51
+ | AgentOutput
52
+ | BashOutput
53
+ | ExitPlanModeOutput
54
+ | FileEditOutput
55
+ | FileReadOutput
56
+ | FileWriteOutput
57
+ | GlobOutput
58
+ | GrepOutput
59
+ | TaskStopOutput
60
+ | ListMcpResourcesOutput
61
+ | McpOutput
62
+ | NotebookEditOutput
63
+ | ReadMcpResourceOutput
64
+ | TodoWriteOutput
65
+ | WebFetchOutput
66
+ | WebSearchOutput
67
+ | AskUserQuestionOutput
68
+ | EnterWorktreeOutput
69
+ | ExitWorktreeOutput
70
+ | TaskCreateOutput
71
+ | TaskGetOutput
72
+ | TaskUpdateOutput
73
+ | TaskListOutput
74
+ | ArtifactOutput
75
+ | RemoteTriggerOutput
76
+ | ShowOnboardingRolePickerOutput
77
+ | ScheduleWakeupOutput
78
+ | MonitorOutput
79
+ | EnterPlanModeOutput
80
+ | REPLOutput
81
+ | WorkflowOutput
82
+ | CronCreateOutput
83
+ | CronDeleteOutput
84
+ | CronListOutput
85
+ | PushNotificationOutput
86
+ | ProjectsOutput;
87
+ export type AgentOutput =
88
+ | {
89
+ agentId: string;
90
+ agentType?: string;
91
+ content: {
92
+ type: "text";
93
+ text: string;
94
+ }[];
95
+ resolvedModel?: string;
96
+ totalToolUseCount: number;
97
+ totalDurationMs: number;
98
+ totalTokens: number;
99
+ usage: {
100
+ input_tokens: number;
101
+ output_tokens: number;
102
+ cache_creation_input_tokens: number | null;
103
+ cache_read_input_tokens: number | null;
104
+ server_tool_use: {
105
+ web_search_requests: number;
106
+ web_fetch_requests: number;
107
+ } | null;
108
+ service_tier: ("standard" | "priority" | "batch") | null;
109
+ cache_creation: {
110
+ ephemeral_1h_input_tokens: number;
111
+ ephemeral_5m_input_tokens: number;
112
+ } | null;
113
+ };
114
+ toolStats?: {
115
+ readCount: number;
116
+ searchCount: number;
117
+ bashCount: number;
118
+ editFileCount: number;
119
+ linesAdded: number;
120
+ linesRemoved: number;
121
+ otherToolCount: number;
122
+ };
123
+ status: "completed";
124
+ prompt: string;
125
+ }
126
+ | {
127
+ status: "async_launched";
128
+ /**
129
+ * The ID of the async agent
130
+ */
131
+ agentId: string;
132
+ /**
133
+ * The description of the task
134
+ */
135
+ description: string;
136
+ /**
137
+ * Model the spawn resolved (may differ from the requested one)
138
+ */
139
+ resolvedModel?: string;
140
+ /**
141
+ * The prompt for the agent
142
+ */
143
+ prompt: string;
144
+ /**
145
+ * Path to the output file for checking agent progress
146
+ */
147
+ outputFile: string;
148
+ /**
149
+ * Whether the calling agent has Read/Bash tools to check progress
150
+ */
151
+ canReadOutputFile?: boolean;
152
+ };
153
+ export type FileReadOutput =
154
+ | {
155
+ type: "text";
156
+ file: {
157
+ /**
158
+ * The path to the file that was read
159
+ */
160
+ filePath: string;
161
+ /**
162
+ * The content of the file
163
+ */
164
+ content: string;
165
+ /**
166
+ * Number of lines in the returned content
167
+ */
168
+ numLines: number;
169
+ /**
170
+ * The starting line number
171
+ */
172
+ startLine: number;
173
+ /**
174
+ * Total number of lines in the file
175
+ */
176
+ totalLines: number;
177
+ /**
178
+ * True when a whole-file read was auto-paginated because it exceeded the token cap (the content is a partial first page). A programmatic signal for internal consumers; survives output reconstruction (unlike the render-time banner).
179
+ */
180
+ truncatedByTokenCap?: boolean;
181
+ };
182
+ }
183
+ | {
184
+ type: "image";
185
+ file: {
186
+ /**
187
+ * Base64-encoded image data
188
+ */
189
+ base64: string;
190
+ /**
191
+ * The MIME type of the image
192
+ */
193
+ type: "image/jpeg" | "image/png" | "image/gif" | "image/webp";
194
+ /**
195
+ * Original file size in bytes
196
+ */
197
+ originalSize: number;
198
+ /**
199
+ * Image dimension info for coordinate mapping
200
+ */
201
+ dimensions?: {
202
+ /**
203
+ * Original image width in pixels
204
+ */
205
+ originalWidth?: number;
206
+ /**
207
+ * Original image height in pixels
208
+ */
209
+ originalHeight?: number;
210
+ /**
211
+ * Displayed image width in pixels (after resizing)
212
+ */
213
+ displayWidth?: number;
214
+ /**
215
+ * Displayed image height in pixels (after resizing)
216
+ */
217
+ displayHeight?: number;
218
+ };
219
+ };
220
+ }
221
+ | {
222
+ type: "notebook";
223
+ file: {
224
+ /**
225
+ * The path to the notebook file
226
+ */
227
+ filePath: string;
228
+ /**
229
+ * Array of notebook cells
230
+ */
231
+ cells: unknown[];
232
+ };
233
+ }
234
+ | {
235
+ type: "pdf";
236
+ file: {
237
+ /**
238
+ * The path to the PDF file
239
+ */
240
+ filePath: string;
241
+ /**
242
+ * Base64-encoded PDF data
243
+ */
244
+ base64: string;
245
+ /**
246
+ * Original file size in bytes
247
+ */
248
+ originalSize: number;
249
+ };
250
+ }
251
+ | {
252
+ type: "parts";
253
+ file: {
254
+ /**
255
+ * The path to the PDF file
256
+ */
257
+ filePath: string;
258
+ /**
259
+ * Original file size in bytes
260
+ */
261
+ originalSize: number;
262
+ /**
263
+ * Number of pages extracted
264
+ */
265
+ count: number;
266
+ /**
267
+ * Directory containing extracted page images
268
+ */
269
+ outputDir: string;
270
+ };
271
+ }
272
+ | {
273
+ type: "file_unchanged";
274
+ file: {
275
+ /**
276
+ * The path to the file
277
+ */
278
+ filePath: string;
279
+ };
280
+ };
281
+ export type ListMcpResourcesOutput = {
282
+ /**
283
+ * Resource URI
284
+ */
285
+ uri: string;
286
+ /**
287
+ * Resource name
288
+ */
289
+ name: string;
290
+ /**
291
+ * MIME type of the resource
292
+ */
293
+ mimeType?: string;
294
+ /**
295
+ * Resource description
296
+ */
297
+ description?: string;
298
+ /**
299
+ * Server that provides this resource
300
+ */
301
+ server: string;
302
+ }[];
303
+ /**
304
+ * MCP tool execution result
305
+ */
306
+ export type McpOutput =
307
+ | string
308
+ | {
309
+ type: string;
310
+ [k: string]: unknown;
311
+ }[]
312
+ | {
313
+ [k: string]: unknown;
314
+ };
315
+ export type ProjectsOutput =
316
+ | {
317
+ method: "project_info";
318
+ notice?: string;
319
+ name: string;
320
+ description: string;
321
+ instructions: string;
322
+ docs: {
323
+ path: string;
324
+ created_at: string | null;
325
+ }[];
326
+ files?: {
327
+ path: string;
328
+ file_kind: string;
329
+ created_at: string | null;
330
+ }[];
331
+ sync_sources?: {
332
+ type: string | null;
333
+ config: {
334
+ [k: string]: unknown;
335
+ };
336
+ }[];
337
+ knowledge: {
338
+ knowledge_size: number;
339
+ max_knowledge_size: number;
340
+ search_threshold: number | null;
341
+ rag_active: boolean;
342
+ remaining_budget: number | null;
343
+ };
344
+ }
345
+ | {
346
+ method: "project_read";
347
+ notice?: string;
348
+ path: string;
349
+ file_kind?: string;
350
+ content?: string;
351
+ local_file?: string;
352
+ created_at: string | null;
353
+ }
354
+ | {
355
+ method: "project_search";
356
+ notice?: string;
357
+ rag: boolean;
358
+ hits?: {
359
+ name?: string;
360
+ doc_uuid?: string;
361
+ text?: string;
362
+ }[];
363
+ docs?: string[];
364
+ }
365
+ | {
366
+ method: "project_write";
367
+ notice?: string;
368
+ path: string;
369
+ doc_uuid: string;
370
+ replaced: boolean;
371
+ knowledge: {
372
+ knowledge_size: number;
373
+ max_knowledge_size: number;
374
+ search_threshold: number | null;
375
+ rag_active: boolean;
376
+ remaining_budget: number | null;
377
+ };
378
+ }
379
+ | {
380
+ method: "project_delete";
381
+ notice?: string;
382
+ path: string;
383
+ deleted: boolean;
384
+ };
385
+
386
+ export interface AgentInput {
387
+ /**
388
+ * A short (3-5 word) description of the task
389
+ */
390
+ description: string;
391
+ /**
392
+ * The task for the agent to perform
393
+ */
394
+ prompt: string;
395
+ /**
396
+ * The type of specialized agent to use for this task
397
+ */
398
+ subagent_type?: string;
399
+ /**
400
+ * 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. Ignored for subagent_type: "fork" — forks always inherit the parent model.
401
+ */
402
+ model?: "sonnet" | "opus" | "haiku" | "fable";
403
+ /**
404
+ * Set to true to run this agent in the background. You will be notified when it completes.
405
+ */
406
+ run_in_background?: boolean;
407
+ /**
408
+ * Name for the spawned agent. Makes it addressable via SendMessage({to: name}) while running.
409
+ */
410
+ name?: string;
411
+ /**
412
+ * Team name for spawning. Uses current team context if omitted.
413
+ */
414
+ team_name?: string;
415
+ /**
416
+ * Permission mode for spawned teammate (e.g., "plan" to require plan approval).
417
+ */
418
+ mode?: "acceptEdits" | "auto" | "bypassPermissions" | "default" | "dontAsk" | "plan" | "bubble";
419
+ /**
420
+ * Isolation mode. "worktree" creates a temporary git worktree so the agent works on an isolated copy of the repo.
421
+ */
422
+ isolation?: "worktree";
423
+ }
424
+ export interface BashInput {
425
+ /**
426
+ * The command to execute
427
+ */
428
+ command: string;
429
+ /**
430
+ * Optional timeout in milliseconds (max 600000)
431
+ */
432
+ timeout?: number;
433
+ /**
434
+ * 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.
435
+ *
436
+ * For simple commands (git, npm, standard CLI tools), keep it brief (5-10 words):
437
+ * - ls → "List files in current directory"
438
+ * - git status → "Show working tree status"
439
+ * - npm install → "Install package dependencies"
440
+ *
441
+ * For commands that are harder to parse at a glance (piped commands, obscure flags, etc.), add enough context to clarify what it does:
442
+ * - find . -name "*.tmp" -exec rm {} \; → "Find and delete all .tmp files recursively"
443
+ * - git reset --hard origin/main → "Discard all local changes and match remote main"
444
+ * - curl -s url | jq '.data[]' → "Fetch JSON from URL and extract data array elements"
445
+ */
446
+ description?: string;
447
+ /**
448
+ * Set to true to run this command in the background.
449
+ */
450
+ run_in_background?: boolean;
451
+ /**
452
+ * Set this to true to dangerously override sandbox mode and run commands without sandboxing.
453
+ */
454
+ dangerouslyDisableSandbox?: boolean;
455
+ }
456
+ export interface TaskOutputInput {
457
+ /**
458
+ * The task ID to get output from
459
+ */
460
+ task_id: string;
461
+ /**
462
+ * Whether to wait for completion
463
+ */
464
+ block: boolean;
465
+ /**
466
+ * Max wait time in ms
467
+ */
468
+ timeout: number;
469
+ }
470
+ export interface ExitPlanModeInput {
471
+ /**
472
+ * Prompt-based permissions needed to implement the plan. These describe categories of actions rather than specific commands.
473
+ */
474
+ allowedPrompts?: {
475
+ /**
476
+ * The tool this prompt applies to
477
+ */
478
+ tool: "Bash";
479
+ /**
480
+ * Semantic description of the action, e.g. "run tests", "install dependencies"
481
+ */
482
+ prompt: string;
483
+ }[];
484
+ [k: string]: unknown;
485
+ }
486
+ export interface FileEditInput {
487
+ /**
488
+ * The absolute path to the file to modify
489
+ */
490
+ file_path: string;
491
+ /**
492
+ * The text to replace
493
+ */
494
+ old_string: string;
495
+ /**
496
+ * The text to replace it with (must be different from old_string)
497
+ */
498
+ new_string: string;
499
+ /**
500
+ * Replace all occurrences of old_string (default false)
501
+ */
502
+ replace_all?: boolean;
503
+ }
504
+ export interface FileReadInput {
505
+ /**
506
+ * The absolute path to the file to read
507
+ */
508
+ file_path: string;
509
+ /**
510
+ * The line number to start reading from. Only provide if the file is too large to read at once
511
+ */
512
+ offset?: number;
513
+ /**
514
+ * The number of lines to read. Only provide if the file is too large to read at once.
515
+ */
516
+ limit?: number;
517
+ /**
518
+ * Page range for PDF files (e.g., "1-5", "3", "10-20"). Only applicable to PDF files. Maximum 20 pages per request.
519
+ */
520
+ pages?: string;
521
+ }
522
+ export interface FileWriteInput {
523
+ /**
524
+ * The absolute path to the file to write (must be absolute, not relative)
525
+ */
526
+ file_path: string;
527
+ /**
528
+ * The content to write to the file
529
+ */
530
+ content: string;
531
+ }
532
+ export interface GlobInput {
533
+ /**
534
+ * The glob pattern to match files against
535
+ */
536
+ pattern: string;
537
+ /**
538
+ * 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.
539
+ */
540
+ path?: string;
541
+ }
542
+ export interface GrepInput {
543
+ /**
544
+ * The regular expression pattern to search for in file contents
545
+ */
546
+ pattern: string;
547
+ /**
548
+ * File or directory to search in (rg PATH). Defaults to current working directory.
549
+ */
550
+ path?: string;
551
+ /**
552
+ * Glob pattern to filter files (e.g. "*.js", "*.{ts,tsx}") - maps to rg --glob
553
+ */
554
+ glob?: string;
555
+ /**
556
+ * 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".
557
+ */
558
+ output_mode?: "content" | "files_with_matches" | "count";
559
+ /**
560
+ * Number of lines to show before each match (rg -B). Requires output_mode: "content", ignored otherwise.
561
+ */
562
+ "-B"?: number;
563
+ /**
564
+ * Number of lines to show after each match (rg -A). Requires output_mode: "content", ignored otherwise.
565
+ */
566
+ "-A"?: number;
567
+ /**
568
+ * Alias for context.
569
+ */
570
+ "-C"?: number;
571
+ /**
572
+ * Number of lines to show before and after each match (rg -C). Requires output_mode: "content", ignored otherwise.
573
+ */
574
+ context?: number;
575
+ /**
576
+ * Show line numbers in output (rg -n). Requires output_mode: "content", ignored otherwise. Defaults to true.
577
+ */
578
+ "-n"?: boolean;
579
+ /**
580
+ * Case insensitive search (rg -i)
581
+ */
582
+ "-i"?: boolean;
583
+ /**
584
+ * Print only the matched (non-empty) parts of each matching line, one match per output line (rg -o / --only-matching). Requires output_mode: "content", ignored otherwise. Defaults to false.
585
+ */
586
+ "-o"?: boolean;
587
+ /**
588
+ * File type to search (rg --type). Common types: js, py, rust, go, java, etc. More efficient than include for standard file types.
589
+ */
590
+ type?: string;
591
+ /**
592
+ * 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).
593
+ */
594
+ head_limit?: number;
595
+ /**
596
+ * Skip first N lines/entries before applying head_limit, equivalent to "| tail -n +N | head -N". Works across all output modes. Defaults to 0.
597
+ */
598
+ offset?: number;
599
+ /**
600
+ * Enable multiline mode where . matches newlines and patterns can span lines (rg -U --multiline-dotall). Default: false.
601
+ */
602
+ multiline?: boolean;
603
+ }
604
+ export interface TaskStopInput {
605
+ /**
606
+ * The ID of the background task to stop
607
+ */
608
+ task_id?: string;
609
+ /**
610
+ * Deprecated: use task_id instead
611
+ */
612
+ shell_id?: string;
613
+ }
614
+ export interface ListMcpResourcesInput {
615
+ /**
616
+ * Optional server name to filter resources by
617
+ */
618
+ server?: string;
619
+ }
620
+ export interface McpInput {
621
+ [k: string]: unknown;
622
+ }
623
+ export interface NotebookEditInput {
624
+ /**
625
+ * The absolute path to the Jupyter notebook file to edit (must be absolute, not relative)
626
+ */
627
+ notebook_path: string;
628
+ /**
629
+ * 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.
630
+ */
631
+ cell_id?: string;
632
+ /**
633
+ * The new source for the cell
634
+ */
635
+ new_source: string;
636
+ /**
637
+ * 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.
638
+ */
639
+ cell_type?: "code" | "markdown";
640
+ /**
641
+ * The type of edit to make (replace, insert, delete). Defaults to replace.
642
+ */
643
+ edit_mode?: "replace" | "insert" | "delete";
644
+ }
645
+ export interface ReadMcpResourceInput {
646
+ /**
647
+ * The MCP server name
648
+ */
649
+ server: string;
650
+ /**
651
+ * The resource URI to read
652
+ */
653
+ uri: string;
654
+ }
655
+ export interface TodoWriteInput {
656
+ /**
657
+ * The updated todo list
658
+ */
659
+ todos: {
660
+ content: string;
661
+ status: "pending" | "in_progress" | "completed";
662
+ activeForm: string;
663
+ }[];
664
+ }
665
+ export interface WebFetchInput {
666
+ /**
667
+ * The URL to fetch content from
668
+ */
669
+ url: string;
670
+ /**
671
+ * The prompt to run on the fetched content
672
+ */
673
+ prompt: string;
674
+ }
675
+ export interface WebSearchInput {
676
+ /**
677
+ * The search query to use
678
+ */
679
+ query: string;
680
+ /**
681
+ * Only include search results from these domains
682
+ */
683
+ allowed_domains?: string[];
684
+ /**
685
+ * Never include search results from these domains
686
+ */
687
+ blocked_domains?: string[];
688
+ }
689
+ export interface AskUserQuestionInput {
690
+ /**
691
+ * Questions to ask the user (1-4 questions)
692
+ *
693
+ * @minItems 1
694
+ * @maxItems 4
695
+ */
696
+ questions:
697
+ | [
698
+ {
699
+ /**
700
+ * 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?"
701
+ */
702
+ question: string;
703
+ /**
704
+ * Very short label displayed as a chip/tag (max 12 chars). Examples: "Auth method", "Library", "Approach".
705
+ */
706
+ header: string;
707
+ /**
708
+ * 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.
709
+ *
710
+ * @minItems 2
711
+ * @maxItems 4
712
+ */
713
+ options:
714
+ | [
715
+ {
716
+ /**
717
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
718
+ */
719
+ label: string;
720
+ /**
721
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
722
+ */
723
+ description: string;
724
+ /**
725
+ * 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.
726
+ */
727
+ preview?: string;
728
+ },
729
+ {
730
+ /**
731
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
732
+ */
733
+ label: string;
734
+ /**
735
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
736
+ */
737
+ description: string;
738
+ /**
739
+ * 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.
740
+ */
741
+ preview?: string;
742
+ }
743
+ ]
744
+ | [
745
+ {
746
+ /**
747
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
748
+ */
749
+ label: string;
750
+ /**
751
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
752
+ */
753
+ description: string;
754
+ /**
755
+ * 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.
756
+ */
757
+ preview?: string;
758
+ },
759
+ {
760
+ /**
761
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
762
+ */
763
+ label: string;
764
+ /**
765
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
766
+ */
767
+ description: string;
768
+ /**
769
+ * 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.
770
+ */
771
+ preview?: string;
772
+ },
773
+ {
774
+ /**
775
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
776
+ */
777
+ label: string;
778
+ /**
779
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
780
+ */
781
+ description: string;
782
+ /**
783
+ * 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.
784
+ */
785
+ preview?: string;
786
+ }
787
+ ]
788
+ | [
789
+ {
790
+ /**
791
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
792
+ */
793
+ label: string;
794
+ /**
795
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
796
+ */
797
+ description: string;
798
+ /**
799
+ * 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.
800
+ */
801
+ preview?: string;
802
+ },
803
+ {
804
+ /**
805
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
806
+ */
807
+ label: string;
808
+ /**
809
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
810
+ */
811
+ description: string;
812
+ /**
813
+ * 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.
814
+ */
815
+ preview?: string;
816
+ },
817
+ {
818
+ /**
819
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
820
+ */
821
+ label: string;
822
+ /**
823
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
824
+ */
825
+ description: string;
826
+ /**
827
+ * 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.
828
+ */
829
+ preview?: string;
830
+ },
831
+ {
832
+ /**
833
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
834
+ */
835
+ label: string;
836
+ /**
837
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
838
+ */
839
+ description: string;
840
+ /**
841
+ * 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.
842
+ */
843
+ preview?: string;
844
+ }
845
+ ];
846
+ /**
847
+ * Set to true to allow the user to select multiple options instead of just one. Use when choices are not mutually exclusive.
848
+ */
849
+ multiSelect: boolean;
850
+ }
851
+ ]
852
+ | [
853
+ {
854
+ /**
855
+ * 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?"
856
+ */
857
+ question: string;
858
+ /**
859
+ * Very short label displayed as a chip/tag (max 12 chars). Examples: "Auth method", "Library", "Approach".
860
+ */
861
+ header: string;
862
+ /**
863
+ * 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.
864
+ *
865
+ * @minItems 2
866
+ * @maxItems 4
867
+ */
868
+ options:
869
+ | [
870
+ {
871
+ /**
872
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
873
+ */
874
+ label: string;
875
+ /**
876
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
877
+ */
878
+ description: string;
879
+ /**
880
+ * 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.
881
+ */
882
+ preview?: string;
883
+ },
884
+ {
885
+ /**
886
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
887
+ */
888
+ label: string;
889
+ /**
890
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
891
+ */
892
+ description: string;
893
+ /**
894
+ * 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.
895
+ */
896
+ preview?: string;
897
+ }
898
+ ]
899
+ | [
900
+ {
901
+ /**
902
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
903
+ */
904
+ label: string;
905
+ /**
906
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
907
+ */
908
+ description: string;
909
+ /**
910
+ * 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.
911
+ */
912
+ preview?: string;
913
+ },
914
+ {
915
+ /**
916
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
917
+ */
918
+ label: string;
919
+ /**
920
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
921
+ */
922
+ description: string;
923
+ /**
924
+ * 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.
925
+ */
926
+ preview?: string;
927
+ },
928
+ {
929
+ /**
930
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
931
+ */
932
+ label: string;
933
+ /**
934
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
935
+ */
936
+ description: string;
937
+ /**
938
+ * 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.
939
+ */
940
+ preview?: string;
941
+ }
942
+ ]
943
+ | [
944
+ {
945
+ /**
946
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
947
+ */
948
+ label: string;
949
+ /**
950
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
951
+ */
952
+ description: string;
953
+ /**
954
+ * 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.
955
+ */
956
+ preview?: string;
957
+ },
958
+ {
959
+ /**
960
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
961
+ */
962
+ label: string;
963
+ /**
964
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
965
+ */
966
+ description: string;
967
+ /**
968
+ * 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.
969
+ */
970
+ preview?: string;
971
+ },
972
+ {
973
+ /**
974
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
975
+ */
976
+ label: string;
977
+ /**
978
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
979
+ */
980
+ description: string;
981
+ /**
982
+ * 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.
983
+ */
984
+ preview?: string;
985
+ },
986
+ {
987
+ /**
988
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
989
+ */
990
+ label: string;
991
+ /**
992
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
993
+ */
994
+ description: string;
995
+ /**
996
+ * 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.
997
+ */
998
+ preview?: string;
999
+ }
1000
+ ];
1001
+ /**
1002
+ * Set to true to allow the user to select multiple options instead of just one. Use when choices are not mutually exclusive.
1003
+ */
1004
+ multiSelect: boolean;
1005
+ },
1006
+ {
1007
+ /**
1008
+ * 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?"
1009
+ */
1010
+ question: string;
1011
+ /**
1012
+ * Very short label displayed as a chip/tag (max 12 chars). Examples: "Auth method", "Library", "Approach".
1013
+ */
1014
+ header: string;
1015
+ /**
1016
+ * 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.
1017
+ *
1018
+ * @minItems 2
1019
+ * @maxItems 4
1020
+ */
1021
+ options:
1022
+ | [
1023
+ {
1024
+ /**
1025
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1026
+ */
1027
+ label: string;
1028
+ /**
1029
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1030
+ */
1031
+ description: string;
1032
+ /**
1033
+ * 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.
1034
+ */
1035
+ preview?: string;
1036
+ },
1037
+ {
1038
+ /**
1039
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1040
+ */
1041
+ label: string;
1042
+ /**
1043
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1044
+ */
1045
+ description: string;
1046
+ /**
1047
+ * 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.
1048
+ */
1049
+ preview?: string;
1050
+ }
1051
+ ]
1052
+ | [
1053
+ {
1054
+ /**
1055
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1056
+ */
1057
+ label: string;
1058
+ /**
1059
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1060
+ */
1061
+ description: string;
1062
+ /**
1063
+ * 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.
1064
+ */
1065
+ preview?: string;
1066
+ },
1067
+ {
1068
+ /**
1069
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1070
+ */
1071
+ label: string;
1072
+ /**
1073
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1074
+ */
1075
+ description: string;
1076
+ /**
1077
+ * 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.
1078
+ */
1079
+ preview?: string;
1080
+ },
1081
+ {
1082
+ /**
1083
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1084
+ */
1085
+ label: string;
1086
+ /**
1087
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1088
+ */
1089
+ description: string;
1090
+ /**
1091
+ * 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.
1092
+ */
1093
+ preview?: string;
1094
+ }
1095
+ ]
1096
+ | [
1097
+ {
1098
+ /**
1099
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1100
+ */
1101
+ label: string;
1102
+ /**
1103
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1104
+ */
1105
+ description: string;
1106
+ /**
1107
+ * 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.
1108
+ */
1109
+ preview?: string;
1110
+ },
1111
+ {
1112
+ /**
1113
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1114
+ */
1115
+ label: string;
1116
+ /**
1117
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1118
+ */
1119
+ description: string;
1120
+ /**
1121
+ * 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.
1122
+ */
1123
+ preview?: string;
1124
+ },
1125
+ {
1126
+ /**
1127
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1128
+ */
1129
+ label: string;
1130
+ /**
1131
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1132
+ */
1133
+ description: string;
1134
+ /**
1135
+ * 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.
1136
+ */
1137
+ preview?: string;
1138
+ },
1139
+ {
1140
+ /**
1141
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1142
+ */
1143
+ label: string;
1144
+ /**
1145
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1146
+ */
1147
+ description: string;
1148
+ /**
1149
+ * 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.
1150
+ */
1151
+ preview?: string;
1152
+ }
1153
+ ];
1154
+ /**
1155
+ * Set to true to allow the user to select multiple options instead of just one. Use when choices are not mutually exclusive.
1156
+ */
1157
+ multiSelect: boolean;
1158
+ }
1159
+ ]
1160
+ | [
1161
+ {
1162
+ /**
1163
+ * 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?"
1164
+ */
1165
+ question: string;
1166
+ /**
1167
+ * Very short label displayed as a chip/tag (max 12 chars). Examples: "Auth method", "Library", "Approach".
1168
+ */
1169
+ header: string;
1170
+ /**
1171
+ * 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.
1172
+ *
1173
+ * @minItems 2
1174
+ * @maxItems 4
1175
+ */
1176
+ options:
1177
+ | [
1178
+ {
1179
+ /**
1180
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1181
+ */
1182
+ label: string;
1183
+ /**
1184
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1185
+ */
1186
+ description: string;
1187
+ /**
1188
+ * 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.
1189
+ */
1190
+ preview?: string;
1191
+ },
1192
+ {
1193
+ /**
1194
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1195
+ */
1196
+ label: string;
1197
+ /**
1198
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1199
+ */
1200
+ description: string;
1201
+ /**
1202
+ * 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.
1203
+ */
1204
+ preview?: string;
1205
+ }
1206
+ ]
1207
+ | [
1208
+ {
1209
+ /**
1210
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1211
+ */
1212
+ label: string;
1213
+ /**
1214
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1215
+ */
1216
+ description: string;
1217
+ /**
1218
+ * 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.
1219
+ */
1220
+ preview?: string;
1221
+ },
1222
+ {
1223
+ /**
1224
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1225
+ */
1226
+ label: string;
1227
+ /**
1228
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1229
+ */
1230
+ description: string;
1231
+ /**
1232
+ * 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.
1233
+ */
1234
+ preview?: string;
1235
+ },
1236
+ {
1237
+ /**
1238
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1239
+ */
1240
+ label: string;
1241
+ /**
1242
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1243
+ */
1244
+ description: string;
1245
+ /**
1246
+ * 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.
1247
+ */
1248
+ preview?: string;
1249
+ }
1250
+ ]
1251
+ | [
1252
+ {
1253
+ /**
1254
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1255
+ */
1256
+ label: string;
1257
+ /**
1258
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1259
+ */
1260
+ description: string;
1261
+ /**
1262
+ * 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.
1263
+ */
1264
+ preview?: string;
1265
+ },
1266
+ {
1267
+ /**
1268
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1269
+ */
1270
+ label: string;
1271
+ /**
1272
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1273
+ */
1274
+ description: string;
1275
+ /**
1276
+ * 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.
1277
+ */
1278
+ preview?: string;
1279
+ },
1280
+ {
1281
+ /**
1282
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1283
+ */
1284
+ label: string;
1285
+ /**
1286
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1287
+ */
1288
+ description: string;
1289
+ /**
1290
+ * 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.
1291
+ */
1292
+ preview?: string;
1293
+ },
1294
+ {
1295
+ /**
1296
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1297
+ */
1298
+ label: string;
1299
+ /**
1300
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1301
+ */
1302
+ description: string;
1303
+ /**
1304
+ * 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.
1305
+ */
1306
+ preview?: string;
1307
+ }
1308
+ ];
1309
+ /**
1310
+ * Set to true to allow the user to select multiple options instead of just one. Use when choices are not mutually exclusive.
1311
+ */
1312
+ multiSelect: boolean;
1313
+ },
1314
+ {
1315
+ /**
1316
+ * 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?"
1317
+ */
1318
+ question: string;
1319
+ /**
1320
+ * Very short label displayed as a chip/tag (max 12 chars). Examples: "Auth method", "Library", "Approach".
1321
+ */
1322
+ header: string;
1323
+ /**
1324
+ * 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.
1325
+ *
1326
+ * @minItems 2
1327
+ * @maxItems 4
1328
+ */
1329
+ options:
1330
+ | [
1331
+ {
1332
+ /**
1333
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1334
+ */
1335
+ label: string;
1336
+ /**
1337
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1338
+ */
1339
+ description: string;
1340
+ /**
1341
+ * 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.
1342
+ */
1343
+ preview?: string;
1344
+ },
1345
+ {
1346
+ /**
1347
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1348
+ */
1349
+ label: string;
1350
+ /**
1351
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1352
+ */
1353
+ description: string;
1354
+ /**
1355
+ * 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.
1356
+ */
1357
+ preview?: string;
1358
+ }
1359
+ ]
1360
+ | [
1361
+ {
1362
+ /**
1363
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1364
+ */
1365
+ label: string;
1366
+ /**
1367
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1368
+ */
1369
+ description: string;
1370
+ /**
1371
+ * 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.
1372
+ */
1373
+ preview?: string;
1374
+ },
1375
+ {
1376
+ /**
1377
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1378
+ */
1379
+ label: string;
1380
+ /**
1381
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1382
+ */
1383
+ description: string;
1384
+ /**
1385
+ * 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.
1386
+ */
1387
+ preview?: string;
1388
+ },
1389
+ {
1390
+ /**
1391
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1392
+ */
1393
+ label: string;
1394
+ /**
1395
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1396
+ */
1397
+ description: string;
1398
+ /**
1399
+ * 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.
1400
+ */
1401
+ preview?: string;
1402
+ }
1403
+ ]
1404
+ | [
1405
+ {
1406
+ /**
1407
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1408
+ */
1409
+ label: string;
1410
+ /**
1411
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1412
+ */
1413
+ description: string;
1414
+ /**
1415
+ * 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.
1416
+ */
1417
+ preview?: string;
1418
+ },
1419
+ {
1420
+ /**
1421
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1422
+ */
1423
+ label: string;
1424
+ /**
1425
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1426
+ */
1427
+ description: string;
1428
+ /**
1429
+ * 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.
1430
+ */
1431
+ preview?: string;
1432
+ },
1433
+ {
1434
+ /**
1435
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1436
+ */
1437
+ label: string;
1438
+ /**
1439
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1440
+ */
1441
+ description: string;
1442
+ /**
1443
+ * 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.
1444
+ */
1445
+ preview?: string;
1446
+ },
1447
+ {
1448
+ /**
1449
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1450
+ */
1451
+ label: string;
1452
+ /**
1453
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1454
+ */
1455
+ description: string;
1456
+ /**
1457
+ * 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.
1458
+ */
1459
+ preview?: string;
1460
+ }
1461
+ ];
1462
+ /**
1463
+ * Set to true to allow the user to select multiple options instead of just one. Use when choices are not mutually exclusive.
1464
+ */
1465
+ multiSelect: boolean;
1466
+ },
1467
+ {
1468
+ /**
1469
+ * 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?"
1470
+ */
1471
+ question: string;
1472
+ /**
1473
+ * Very short label displayed as a chip/tag (max 12 chars). Examples: "Auth method", "Library", "Approach".
1474
+ */
1475
+ header: string;
1476
+ /**
1477
+ * 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.
1478
+ *
1479
+ * @minItems 2
1480
+ * @maxItems 4
1481
+ */
1482
+ options:
1483
+ | [
1484
+ {
1485
+ /**
1486
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1487
+ */
1488
+ label: string;
1489
+ /**
1490
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1491
+ */
1492
+ description: string;
1493
+ /**
1494
+ * 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.
1495
+ */
1496
+ preview?: string;
1497
+ },
1498
+ {
1499
+ /**
1500
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1501
+ */
1502
+ label: string;
1503
+ /**
1504
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1505
+ */
1506
+ description: string;
1507
+ /**
1508
+ * 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.
1509
+ */
1510
+ preview?: string;
1511
+ }
1512
+ ]
1513
+ | [
1514
+ {
1515
+ /**
1516
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1517
+ */
1518
+ label: string;
1519
+ /**
1520
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1521
+ */
1522
+ description: string;
1523
+ /**
1524
+ * 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.
1525
+ */
1526
+ preview?: string;
1527
+ },
1528
+ {
1529
+ /**
1530
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1531
+ */
1532
+ label: string;
1533
+ /**
1534
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1535
+ */
1536
+ description: string;
1537
+ /**
1538
+ * 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.
1539
+ */
1540
+ preview?: string;
1541
+ },
1542
+ {
1543
+ /**
1544
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1545
+ */
1546
+ label: string;
1547
+ /**
1548
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1549
+ */
1550
+ description: string;
1551
+ /**
1552
+ * 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.
1553
+ */
1554
+ preview?: string;
1555
+ }
1556
+ ]
1557
+ | [
1558
+ {
1559
+ /**
1560
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1561
+ */
1562
+ label: string;
1563
+ /**
1564
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1565
+ */
1566
+ description: string;
1567
+ /**
1568
+ * 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.
1569
+ */
1570
+ preview?: string;
1571
+ },
1572
+ {
1573
+ /**
1574
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1575
+ */
1576
+ label: string;
1577
+ /**
1578
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1579
+ */
1580
+ description: string;
1581
+ /**
1582
+ * 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.
1583
+ */
1584
+ preview?: string;
1585
+ },
1586
+ {
1587
+ /**
1588
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1589
+ */
1590
+ label: string;
1591
+ /**
1592
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1593
+ */
1594
+ description: string;
1595
+ /**
1596
+ * 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.
1597
+ */
1598
+ preview?: string;
1599
+ },
1600
+ {
1601
+ /**
1602
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1603
+ */
1604
+ label: string;
1605
+ /**
1606
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1607
+ */
1608
+ description: string;
1609
+ /**
1610
+ * 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.
1611
+ */
1612
+ preview?: string;
1613
+ }
1614
+ ];
1615
+ /**
1616
+ * Set to true to allow the user to select multiple options instead of just one. Use when choices are not mutually exclusive.
1617
+ */
1618
+ multiSelect: boolean;
1619
+ }
1620
+ ]
1621
+ | [
1622
+ {
1623
+ /**
1624
+ * 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?"
1625
+ */
1626
+ question: string;
1627
+ /**
1628
+ * Very short label displayed as a chip/tag (max 12 chars). Examples: "Auth method", "Library", "Approach".
1629
+ */
1630
+ header: string;
1631
+ /**
1632
+ * 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.
1633
+ *
1634
+ * @minItems 2
1635
+ * @maxItems 4
1636
+ */
1637
+ options:
1638
+ | [
1639
+ {
1640
+ /**
1641
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1642
+ */
1643
+ label: string;
1644
+ /**
1645
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1646
+ */
1647
+ description: string;
1648
+ /**
1649
+ * 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.
1650
+ */
1651
+ preview?: string;
1652
+ },
1653
+ {
1654
+ /**
1655
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1656
+ */
1657
+ label: string;
1658
+ /**
1659
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1660
+ */
1661
+ description: string;
1662
+ /**
1663
+ * 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.
1664
+ */
1665
+ preview?: string;
1666
+ }
1667
+ ]
1668
+ | [
1669
+ {
1670
+ /**
1671
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1672
+ */
1673
+ label: string;
1674
+ /**
1675
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1676
+ */
1677
+ description: string;
1678
+ /**
1679
+ * 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.
1680
+ */
1681
+ preview?: string;
1682
+ },
1683
+ {
1684
+ /**
1685
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1686
+ */
1687
+ label: string;
1688
+ /**
1689
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1690
+ */
1691
+ description: string;
1692
+ /**
1693
+ * 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.
1694
+ */
1695
+ preview?: string;
1696
+ },
1697
+ {
1698
+ /**
1699
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1700
+ */
1701
+ label: string;
1702
+ /**
1703
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1704
+ */
1705
+ description: string;
1706
+ /**
1707
+ * 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.
1708
+ */
1709
+ preview?: string;
1710
+ }
1711
+ ]
1712
+ | [
1713
+ {
1714
+ /**
1715
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1716
+ */
1717
+ label: string;
1718
+ /**
1719
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1720
+ */
1721
+ description: string;
1722
+ /**
1723
+ * 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.
1724
+ */
1725
+ preview?: string;
1726
+ },
1727
+ {
1728
+ /**
1729
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1730
+ */
1731
+ label: string;
1732
+ /**
1733
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1734
+ */
1735
+ description: string;
1736
+ /**
1737
+ * 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.
1738
+ */
1739
+ preview?: string;
1740
+ },
1741
+ {
1742
+ /**
1743
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1744
+ */
1745
+ label: string;
1746
+ /**
1747
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1748
+ */
1749
+ description: string;
1750
+ /**
1751
+ * 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.
1752
+ */
1753
+ preview?: string;
1754
+ },
1755
+ {
1756
+ /**
1757
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1758
+ */
1759
+ label: string;
1760
+ /**
1761
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1762
+ */
1763
+ description: string;
1764
+ /**
1765
+ * 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.
1766
+ */
1767
+ preview?: string;
1768
+ }
1769
+ ];
1770
+ /**
1771
+ * Set to true to allow the user to select multiple options instead of just one. Use when choices are not mutually exclusive.
1772
+ */
1773
+ multiSelect: boolean;
1774
+ },
1775
+ {
1776
+ /**
1777
+ * 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?"
1778
+ */
1779
+ question: string;
1780
+ /**
1781
+ * Very short label displayed as a chip/tag (max 12 chars). Examples: "Auth method", "Library", "Approach".
1782
+ */
1783
+ header: string;
1784
+ /**
1785
+ * 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.
1786
+ *
1787
+ * @minItems 2
1788
+ * @maxItems 4
1789
+ */
1790
+ options:
1791
+ | [
1792
+ {
1793
+ /**
1794
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1795
+ */
1796
+ label: string;
1797
+ /**
1798
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1799
+ */
1800
+ description: string;
1801
+ /**
1802
+ * 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.
1803
+ */
1804
+ preview?: string;
1805
+ },
1806
+ {
1807
+ /**
1808
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1809
+ */
1810
+ label: string;
1811
+ /**
1812
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1813
+ */
1814
+ description: string;
1815
+ /**
1816
+ * 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.
1817
+ */
1818
+ preview?: string;
1819
+ }
1820
+ ]
1821
+ | [
1822
+ {
1823
+ /**
1824
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1825
+ */
1826
+ label: string;
1827
+ /**
1828
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1829
+ */
1830
+ description: string;
1831
+ /**
1832
+ * 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.
1833
+ */
1834
+ preview?: string;
1835
+ },
1836
+ {
1837
+ /**
1838
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1839
+ */
1840
+ label: string;
1841
+ /**
1842
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1843
+ */
1844
+ description: string;
1845
+ /**
1846
+ * 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.
1847
+ */
1848
+ preview?: string;
1849
+ },
1850
+ {
1851
+ /**
1852
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1853
+ */
1854
+ label: string;
1855
+ /**
1856
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1857
+ */
1858
+ description: string;
1859
+ /**
1860
+ * 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.
1861
+ */
1862
+ preview?: string;
1863
+ }
1864
+ ]
1865
+ | [
1866
+ {
1867
+ /**
1868
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1869
+ */
1870
+ label: string;
1871
+ /**
1872
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1873
+ */
1874
+ description: string;
1875
+ /**
1876
+ * 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.
1877
+ */
1878
+ preview?: string;
1879
+ },
1880
+ {
1881
+ /**
1882
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1883
+ */
1884
+ label: string;
1885
+ /**
1886
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1887
+ */
1888
+ description: string;
1889
+ /**
1890
+ * 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.
1891
+ */
1892
+ preview?: string;
1893
+ },
1894
+ {
1895
+ /**
1896
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1897
+ */
1898
+ label: string;
1899
+ /**
1900
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1901
+ */
1902
+ description: string;
1903
+ /**
1904
+ * 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.
1905
+ */
1906
+ preview?: string;
1907
+ },
1908
+ {
1909
+ /**
1910
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1911
+ */
1912
+ label: string;
1913
+ /**
1914
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1915
+ */
1916
+ description: string;
1917
+ /**
1918
+ * 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.
1919
+ */
1920
+ preview?: string;
1921
+ }
1922
+ ];
1923
+ /**
1924
+ * Set to true to allow the user to select multiple options instead of just one. Use when choices are not mutually exclusive.
1925
+ */
1926
+ multiSelect: boolean;
1927
+ },
1928
+ {
1929
+ /**
1930
+ * 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?"
1931
+ */
1932
+ question: string;
1933
+ /**
1934
+ * Very short label displayed as a chip/tag (max 12 chars). Examples: "Auth method", "Library", "Approach".
1935
+ */
1936
+ header: string;
1937
+ /**
1938
+ * 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.
1939
+ *
1940
+ * @minItems 2
1941
+ * @maxItems 4
1942
+ */
1943
+ options:
1944
+ | [
1945
+ {
1946
+ /**
1947
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1948
+ */
1949
+ label: string;
1950
+ /**
1951
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1952
+ */
1953
+ description: string;
1954
+ /**
1955
+ * 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.
1956
+ */
1957
+ preview?: string;
1958
+ },
1959
+ {
1960
+ /**
1961
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1962
+ */
1963
+ label: string;
1964
+ /**
1965
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1966
+ */
1967
+ description: string;
1968
+ /**
1969
+ * 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.
1970
+ */
1971
+ preview?: string;
1972
+ }
1973
+ ]
1974
+ | [
1975
+ {
1976
+ /**
1977
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1978
+ */
1979
+ label: string;
1980
+ /**
1981
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1982
+ */
1983
+ description: string;
1984
+ /**
1985
+ * 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.
1986
+ */
1987
+ preview?: string;
1988
+ },
1989
+ {
1990
+ /**
1991
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
1992
+ */
1993
+ label: string;
1994
+ /**
1995
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
1996
+ */
1997
+ description: string;
1998
+ /**
1999
+ * 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.
2000
+ */
2001
+ preview?: string;
2002
+ },
2003
+ {
2004
+ /**
2005
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
2006
+ */
2007
+ label: string;
2008
+ /**
2009
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
2010
+ */
2011
+ description: string;
2012
+ /**
2013
+ * 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.
2014
+ */
2015
+ preview?: string;
2016
+ }
2017
+ ]
2018
+ | [
2019
+ {
2020
+ /**
2021
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
2022
+ */
2023
+ label: string;
2024
+ /**
2025
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
2026
+ */
2027
+ description: string;
2028
+ /**
2029
+ * 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.
2030
+ */
2031
+ preview?: string;
2032
+ },
2033
+ {
2034
+ /**
2035
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
2036
+ */
2037
+ label: string;
2038
+ /**
2039
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
2040
+ */
2041
+ description: string;
2042
+ /**
2043
+ * 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.
2044
+ */
2045
+ preview?: string;
2046
+ },
2047
+ {
2048
+ /**
2049
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
2050
+ */
2051
+ label: string;
2052
+ /**
2053
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
2054
+ */
2055
+ description: string;
2056
+ /**
2057
+ * 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.
2058
+ */
2059
+ preview?: string;
2060
+ },
2061
+ {
2062
+ /**
2063
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
2064
+ */
2065
+ label: string;
2066
+ /**
2067
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
2068
+ */
2069
+ description: string;
2070
+ /**
2071
+ * 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.
2072
+ */
2073
+ preview?: string;
2074
+ }
2075
+ ];
2076
+ /**
2077
+ * Set to true to allow the user to select multiple options instead of just one. Use when choices are not mutually exclusive.
2078
+ */
2079
+ multiSelect: boolean;
2080
+ },
2081
+ {
2082
+ /**
2083
+ * 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?"
2084
+ */
2085
+ question: string;
2086
+ /**
2087
+ * Very short label displayed as a chip/tag (max 12 chars). Examples: "Auth method", "Library", "Approach".
2088
+ */
2089
+ header: string;
2090
+ /**
2091
+ * 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.
2092
+ *
2093
+ * @minItems 2
2094
+ * @maxItems 4
2095
+ */
2096
+ options:
2097
+ | [
2098
+ {
2099
+ /**
2100
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
2101
+ */
2102
+ label: string;
2103
+ /**
2104
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
2105
+ */
2106
+ description: string;
2107
+ /**
2108
+ * 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.
2109
+ */
2110
+ preview?: string;
2111
+ },
2112
+ {
2113
+ /**
2114
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
2115
+ */
2116
+ label: string;
2117
+ /**
2118
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
2119
+ */
2120
+ description: string;
2121
+ /**
2122
+ * 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.
2123
+ */
2124
+ preview?: string;
2125
+ }
2126
+ ]
2127
+ | [
2128
+ {
2129
+ /**
2130
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
2131
+ */
2132
+ label: string;
2133
+ /**
2134
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
2135
+ */
2136
+ description: string;
2137
+ /**
2138
+ * 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.
2139
+ */
2140
+ preview?: string;
2141
+ },
2142
+ {
2143
+ /**
2144
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
2145
+ */
2146
+ label: string;
2147
+ /**
2148
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
2149
+ */
2150
+ description: string;
2151
+ /**
2152
+ * 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.
2153
+ */
2154
+ preview?: string;
2155
+ },
2156
+ {
2157
+ /**
2158
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
2159
+ */
2160
+ label: string;
2161
+ /**
2162
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
2163
+ */
2164
+ description: string;
2165
+ /**
2166
+ * 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.
2167
+ */
2168
+ preview?: string;
2169
+ }
2170
+ ]
2171
+ | [
2172
+ {
2173
+ /**
2174
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
2175
+ */
2176
+ label: string;
2177
+ /**
2178
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
2179
+ */
2180
+ description: string;
2181
+ /**
2182
+ * 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.
2183
+ */
2184
+ preview?: string;
2185
+ },
2186
+ {
2187
+ /**
2188
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
2189
+ */
2190
+ label: string;
2191
+ /**
2192
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
2193
+ */
2194
+ description: string;
2195
+ /**
2196
+ * 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.
2197
+ */
2198
+ preview?: string;
2199
+ },
2200
+ {
2201
+ /**
2202
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
2203
+ */
2204
+ label: string;
2205
+ /**
2206
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
2207
+ */
2208
+ description: string;
2209
+ /**
2210
+ * 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.
2211
+ */
2212
+ preview?: string;
2213
+ },
2214
+ {
2215
+ /**
2216
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
2217
+ */
2218
+ label: string;
2219
+ /**
2220
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
2221
+ */
2222
+ description: string;
2223
+ /**
2224
+ * 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.
2225
+ */
2226
+ preview?: string;
2227
+ }
2228
+ ];
2229
+ /**
2230
+ * Set to true to allow the user to select multiple options instead of just one. Use when choices are not mutually exclusive.
2231
+ */
2232
+ multiSelect: boolean;
2233
+ }
2234
+ ];
2235
+ /**
2236
+ * User answers collected by the permission component
2237
+ */
2238
+ answers?: {
2239
+ [k: string]: string;
2240
+ };
2241
+ /**
2242
+ * Optional per-question annotations from the user (e.g., notes on preview selections). Keyed by question text.
2243
+ */
2244
+ annotations?: {
2245
+ [k: string]: {
2246
+ /**
2247
+ * The preview content of the selected option, if the question used previews.
2248
+ */
2249
+ preview?: string;
2250
+ /**
2251
+ * Free-text notes the user added to their selection.
2252
+ */
2253
+ notes?: string;
2254
+ };
2255
+ };
2256
+ /**
2257
+ * Optional metadata for tracking and analytics purposes. Not displayed to user.
2258
+ */
2259
+ metadata?: {
2260
+ /**
2261
+ * Optional identifier for the source of this question (e.g., "remember" for /remember command). Used for analytics tracking.
2262
+ */
2263
+ source?: string;
2264
+ };
2265
+ }
2266
+ export interface ProjectsInput {
2267
+ method: "project_info" | "project_read" | "project_search" | "project_write" | "project_delete";
2268
+ /**
2269
+ * project_read/project_write/project_delete: doc path. project_write: an existing path is replaced in place; a new bare filename (no "/") is namespaced to "claude/<name>".
2270
+ */
2271
+ path?: string;
2272
+ /**
2273
+ * project_write: inline doc text. Mutually exclusive with local_path. Use local_path for anything you have on disk.
2274
+ */
2275
+ content?: string;
2276
+ /**
2277
+ * project_write: a file inside the working directory to upload. The tool reads, encodes, and uploads directly — contents never enter your context. Mutually exclusive with content.
2278
+ */
2279
+ local_path?: string;
2280
+ /**
2281
+ * project_write: bypass the chat-injection budget guard. Set only when the write is genuinely worth degrading chat to retrieval mode for everyone in the project.
2282
+ */
2283
+ force?: boolean;
2284
+ /**
2285
+ * project_search: knowledge-base query
2286
+ */
2287
+ query?: string;
2288
+ /**
2289
+ * project_search: number of hits (default 5)
2290
+ */
2291
+ n?: number;
2292
+ }
2293
+ export interface EnterPlanModeInput {}
2294
+ export interface TaskCreateInput {
2295
+ /**
2296
+ * A brief title for the task
2297
+ */
2298
+ subject: string;
2299
+ /**
2300
+ * What needs to be done
2301
+ */
2302
+ description: string;
2303
+ /**
2304
+ * Present continuous form shown in spinner when in_progress (e.g., "Running tests")
2305
+ */
2306
+ activeForm?: string;
2307
+ /**
2308
+ * Arbitrary metadata to attach to the task
2309
+ */
2310
+ metadata?: {
2311
+ [k: string]: unknown;
2312
+ };
2313
+ }
2314
+ export interface TaskGetInput {
2315
+ /**
2316
+ * The ID of the task to retrieve
2317
+ */
2318
+ taskId: string;
2319
+ }
2320
+ export interface TaskUpdateInput {
2321
+ /**
2322
+ * The ID of the task to update
2323
+ */
2324
+ taskId: string;
2325
+ /**
2326
+ * New subject for the task
2327
+ */
2328
+ subject?: string;
2329
+ /**
2330
+ * New description for the task
2331
+ */
2332
+ description?: string;
2333
+ /**
2334
+ * Present continuous form shown in spinner when in_progress (e.g., "Running tests")
2335
+ */
2336
+ activeForm?: string;
2337
+ /**
2338
+ * New status for the task
2339
+ */
2340
+ status?: ("pending" | "in_progress" | "completed") | "deleted";
2341
+ /**
2342
+ * Task IDs that this task blocks
2343
+ */
2344
+ addBlocks?: string[];
2345
+ /**
2346
+ * Task IDs that block this task
2347
+ */
2348
+ addBlockedBy?: string[];
2349
+ /**
2350
+ * New owner for the task
2351
+ */
2352
+ owner?: string;
2353
+ /**
2354
+ * Metadata keys to merge into the task. Set a key to null to delete it.
2355
+ */
2356
+ metadata?: {
2357
+ [k: string]: unknown;
2358
+ };
2359
+ }
2360
+ export interface TaskListInput {}
2361
+ export interface REPLInput {
2362
+ /**
2363
+ * JavaScript code to execute. Supports top-level await. State persists across calls.
2364
+ */
2365
+ code: string;
2366
+ /**
2367
+ * Clear, concise description of what this script does in active voice (5-10 words). E.g. "Trace upgrade message to its GrowthBook flag"
2368
+ */
2369
+ description?: string;
2370
+ /**
2371
+ * Optional timeout in milliseconds (default 30000, max 600000)
2372
+ */
2373
+ timeout?: number;
2374
+ }
2375
+ export interface WorkflowInput {
2376
+ /**
2377
+ * Self-contained workflow script. Must begin with `export const meta = { name, description, phases }` (pure literal, no computed values) followed by the script body using agent()/parallel()/pipeline()/phase().
2378
+ */
2379
+ script?: string;
2380
+ /**
2381
+ * Name of a predefined workflow (built-in or from .claude/workflows/). Resolves to a self-contained script.
2382
+ */
2383
+ name?: string;
2384
+ /**
2385
+ * Ignored — set the workflow description in the script's `meta` block.
2386
+ */
2387
+ description?: string;
2388
+ /**
2389
+ * Ignored — set the workflow title in the script's `meta` block.
2390
+ */
2391
+ title?: string;
2392
+ /**
2393
+ * Optional input value exposed to the script as the global `args`, verbatim. Pass arrays/objects as actual JSON values, NOT as a JSON-encoded string — a stringified list breaks `args.filter`/`args.map` in the script. Use for parameterized named workflows (e.g. a research question).
2394
+ */
2395
+ args?: {
2396
+ [k: string]: unknown;
2397
+ };
2398
+ /**
2399
+ * Path to a workflow script file on disk. Every Workflow invocation persists its script under the session directory and returns the path in the tool result. To iterate, edit that file with Write/Edit and re-invoke Workflow with the same `scriptPath` instead of re-sending the full script. Takes precedence over `script` and `name`.
2400
+ */
2401
+ scriptPath?: string;
2402
+ /**
2403
+ * Run ID of a prior Workflow invocation to resume from. Completed agent() calls with unchanged (prompt, opts) return their cached results instantly; only edited or new calls re-run. Same-session only. Stop the prior run first (TaskStop) before resuming.
2404
+ */
2405
+ resumeFromRunId?: string;
2406
+ }
2407
+ export interface CronCreateInput {
2408
+ /**
2409
+ * Standard 5-field cron expression in local time: "M H DoM Mon DoW" (e.g. "* /5 * * * *" = every 5 minutes, "30 14 28 2 *" = Feb 28 at 2:30pm local once).
2410
+ */
2411
+ cron: string;
2412
+ /**
2413
+ * The prompt to enqueue at each fire time.
2414
+ */
2415
+ prompt: string;
2416
+ /**
2417
+ * true (default) = fire on every cron match until deleted or auto-expired after 7 days. false = fire once at the next match, then auto-delete. Use false for "remind me at X" one-shot requests with pinned minute/hour/dom/month.
2418
+ */
2419
+ recurring?: boolean;
2420
+ /**
2421
+ * true = persist to .claude/scheduled_tasks.json and survive restarts. false (default) = in-memory only, dies when this Claude session ends. Use true only when the user asks the task to survive across sessions.
2422
+ */
2423
+ durable?: boolean;
2424
+ }
2425
+ export interface CronDeleteInput {
2426
+ /**
2427
+ * Job ID returned by CronCreate.
2428
+ */
2429
+ id: string;
2430
+ }
2431
+ export interface CronListInput {}
2432
+ export interface ScheduleWakeupInput {
2433
+ /**
2434
+ * Seconds from now to wake up. Clamped to [60, 3600] by the runtime.
2435
+ */
2436
+ delaySeconds: number;
2437
+ /**
2438
+ * One short sentence explaining the chosen delay. Goes to telemetry and is shown to the user. Be specific.
2439
+ */
2440
+ reason: string;
2441
+ /**
2442
+ * The /loop input to fire on wake-up. Pass the same /loop input verbatim each turn so the next firing re-enters the skill and continues the loop. For autonomous /loop (no user prompt), pass the literal sentinel `<<autonomous-loop-dynamic>>` instead (the dynamic-pacing variant, not the CronCreate-mode `<<autonomous-loop>>`).
2443
+ */
2444
+ prompt: string;
2445
+ }
2446
+ export interface RemoteTriggerInput {
2447
+ action: "list" | "get" | "create" | "update" | "run";
2448
+ /**
2449
+ * Required for get, update, and run
2450
+ */
2451
+ trigger_id?: string;
2452
+ /**
2453
+ * Required for create and update; optional for run
2454
+ */
2455
+ body?: {
2456
+ [k: string]: unknown;
2457
+ };
2458
+ }
2459
+ export interface ShowOnboardingRolePickerInput {}
2460
+ export interface MonitorInput {
2461
+ /**
2462
+ * Short human-readable description of what you are monitoring (shown in notifications).
2463
+ */
2464
+ description: string;
2465
+ /**
2466
+ * Kill the monitor after this deadline. Default 300000ms, max 3600000ms. Ignored when persistent is true.
2467
+ */
2468
+ timeout_ms: number;
2469
+ /**
2470
+ * Run for the lifetime of the session (no timeout). Use for session-length watches like PR monitoring or log tails. Stop with TaskStop.
2471
+ */
2472
+ persistent: boolean;
2473
+ /**
2474
+ * Shell command or script. Each stdout line is an event; exit ends the watch.
2475
+ */
2476
+ command: string;
2477
+ }
2478
+ export interface ArtifactInput {
2479
+ /**
2480
+ * Path to an .html or .md file to render. Use a short, distinctive basename — it is the fallback title if the HTML has no <title>.
2481
+ */
2482
+ file_path: string;
2483
+ /**
2484
+ * Browser-tab icon: one or two emoji (e.g. "📊"). No markup. Keep stable across redeploys; change only on a hard topic pivot.
2485
+ */
2486
+ favicon: string;
2487
+ /**
2488
+ * Short human-readable name for this version (e.g. "fixed-background"). Shown in the version picker instead of the raw version id.
2489
+ */
2490
+ label?: string;
2491
+ /**
2492
+ * Existing artifact URL to redeploy to. Pass when the user gives you a URL for an artifact not published in this session; omit for new artifacts or same-session redeploys. Must be an artifact the user owns.
2493
+ */
2494
+ url?: string;
2495
+ }
2496
+ export interface PushNotificationInput {
2497
+ /**
2498
+ * The notification body. Keep it under 200 characters; mobile OSes truncate.
2499
+ */
2500
+ message: string;
2501
+ status: "proactive";
2502
+ }
2503
+ export interface EnterWorktreeInput {
2504
+ /**
2505
+ * Optional name for a new worktree. Each "/"-separated segment may contain only letters, digits, dots, underscores, and dashes; max 64 chars total. A random name is generated if not provided. Mutually exclusive with `path`.
2506
+ */
2507
+ name?: string;
2508
+ /**
2509
+ * Path to an existing worktree of the current repository to switch into instead of creating a new one. Must appear in `git worktree list` for the current repo. Mutually exclusive with `name`.
2510
+ */
2511
+ path?: string;
2512
+ }
2513
+ export interface ExitWorktreeInput {
2514
+ /**
2515
+ * "keep" leaves the worktree and branch on disk; "remove" deletes both.
2516
+ */
2517
+ action: "keep" | "remove";
2518
+ /**
2519
+ * Required true when action is "remove" and the worktree has uncommitted files or unmerged commits. The tool will refuse and list them otherwise.
2520
+ */
2521
+ discard_changes?: boolean;
2522
+ }
2523
+ export interface BashOutput {
2524
+ /**
2525
+ * The standard output of the command
2526
+ */
2527
+ stdout: string;
2528
+ /**
2529
+ * The standard error output of the command
2530
+ */
2531
+ stderr: string;
2532
+ /**
2533
+ * Path to raw output file for large MCP tool outputs
2534
+ */
2535
+ rawOutputPath?: string;
2536
+ /**
2537
+ * Whether the command was interrupted
2538
+ */
2539
+ interrupted: boolean;
2540
+ /**
2541
+ * Flag to indicate if stdout contains image data
2542
+ */
2543
+ isImage?: boolean;
2544
+ /**
2545
+ * ID of the background task if command is running in background
2546
+ */
2547
+ backgroundTaskId?: string;
2548
+ /**
2549
+ * True if the user manually backgrounded the command with Ctrl+B
2550
+ */
2551
+ backgroundedByUser?: boolean;
2552
+ /**
2553
+ * True if assistant-mode auto-backgrounded a long-running blocking command
2554
+ */
2555
+ assistantAutoBackgrounded?: boolean;
2556
+ /**
2557
+ * Flag to indicate if sandbox mode was overridden
2558
+ */
2559
+ dangerouslyDisableSandbox?: boolean;
2560
+ /**
2561
+ * Semantic interpretation for non-error exit codes with special meaning
2562
+ */
2563
+ returnCodeInterpretation?: string;
2564
+ /**
2565
+ * Whether the command is expected to produce no output on success
2566
+ */
2567
+ noOutputExpected?: boolean;
2568
+ /**
2569
+ * Structured content blocks
2570
+ */
2571
+ structuredContent?: unknown[];
2572
+ /**
2573
+ * Path to the persisted full output in tool-results dir (set when output is too large for inline)
2574
+ */
2575
+ persistedOutputPath?: string;
2576
+ /**
2577
+ * Total size of the output in bytes (set when output is too large for inline)
2578
+ */
2579
+ persistedOutputSize?: number;
2580
+ /**
2581
+ * Model-facing note listing readFileState entries whose mtime bumped during this command (set when WRITE_COMMAND_MARKERS matches)
2582
+ */
2583
+ staleReadFileStateHint?: string;
2584
+ /**
2585
+ * Model-facing system-reminder appended when a gh command reports a GitHub API rate-limit error
2586
+ */
2587
+ ghRateLimitHint?: string;
2588
+ /**
2589
+ * @internal Structured classification of git/gh operations detected in this command (commit/push/merge/rebase/PR). Client-facing — lets clients render git activity without re-parsing stdout; not surfaced to the model.
2590
+ */
2591
+ gitOperation?: {
2592
+ commit?: {
2593
+ sha: string;
2594
+ kind: "committed" | "amended" | "cherry-picked";
2595
+ };
2596
+ push?: {
2597
+ branch: string;
2598
+ };
2599
+ branch?: {
2600
+ ref: string;
2601
+ action: "merged" | "rebased";
2602
+ };
2603
+ pr?: {
2604
+ number: number;
2605
+ url?: string;
2606
+ action:
2607
+ | "created"
2608
+ | "edited"
2609
+ | "merged"
2610
+ | "commented"
2611
+ | "closed"
2612
+ | "ready"
2613
+ | "draft"
2614
+ | "auto-merge-enabled"
2615
+ | "auto-merge-disabled";
2616
+ };
2617
+ };
2618
+ }
2619
+ export interface ExitPlanModeOutput {
2620
+ /**
2621
+ * The plan that was presented to the user
2622
+ */
2623
+ plan: string | null;
2624
+ isAgent: boolean;
2625
+ /**
2626
+ * The file path where the plan was saved
2627
+ */
2628
+ filePath?: string;
2629
+ /**
2630
+ * Whether the Agent tool is available in the current context
2631
+ */
2632
+ hasTaskTool?: boolean;
2633
+ /**
2634
+ * True when the user edited the plan (CCR web UI or Ctrl+G); determines whether the plan is echoed back in tool_result
2635
+ */
2636
+ planWasEdited?: boolean;
2637
+ /**
2638
+ * When true, the teammate has sent a plan approval request to the team leader
2639
+ */
2640
+ awaitingLeaderApproval?: boolean;
2641
+ /**
2642
+ * Unique identifier for the plan approval request
2643
+ */
2644
+ requestId?: string;
2645
+ }
2646
+ export interface FileEditOutput {
2647
+ /**
2648
+ * The file path that was edited
2649
+ */
2650
+ filePath: string;
2651
+ /**
2652
+ * The original string that was replaced
2653
+ */
2654
+ oldString: string;
2655
+ /**
2656
+ * The new string that replaced it
2657
+ */
2658
+ newString: string;
2659
+ /**
2660
+ * The original file contents before editing
2661
+ */
2662
+ originalFile: string | null;
2663
+ /**
2664
+ * Diff patch showing the changes
2665
+ */
2666
+ structuredPatch: {
2667
+ oldStart: number;
2668
+ oldLines: number;
2669
+ newStart: number;
2670
+ newLines: number;
2671
+ lines: string[];
2672
+ }[];
2673
+ /**
2674
+ * Whether the user modified the proposed changes
2675
+ */
2676
+ userModified: boolean;
2677
+ /**
2678
+ * Whether all occurrences were replaced
2679
+ */
2680
+ replaceAll: boolean;
2681
+ gitDiff?: {
2682
+ filename: string;
2683
+ status: "modified" | "added";
2684
+ additions: number;
2685
+ deletions: number;
2686
+ changes: number;
2687
+ patch: string;
2688
+ /**
2689
+ * GitHub owner/repo when available
2690
+ */
2691
+ repository?: string | null;
2692
+ };
2693
+ }
2694
+ export interface FileWriteOutput {
2695
+ /**
2696
+ * Whether a new file was created or an existing file was updated
2697
+ */
2698
+ type: "create" | "update";
2699
+ /**
2700
+ * The path to the file that was written
2701
+ */
2702
+ filePath: string;
2703
+ /**
2704
+ * The content that was written to the file
2705
+ */
2706
+ content: string;
2707
+ /**
2708
+ * Diff patch showing the changes
2709
+ */
2710
+ structuredPatch: {
2711
+ oldStart: number;
2712
+ oldLines: number;
2713
+ newStart: number;
2714
+ newLines: number;
2715
+ lines: string[];
2716
+ }[];
2717
+ /**
2718
+ * The original file content before the write (null for new files)
2719
+ */
2720
+ originalFile: string | null;
2721
+ gitDiff?: {
2722
+ filename: string;
2723
+ status: "modified" | "added";
2724
+ additions: number;
2725
+ deletions: number;
2726
+ changes: number;
2727
+ patch: string;
2728
+ /**
2729
+ * GitHub owner/repo when available
2730
+ */
2731
+ repository?: string | null;
2732
+ };
2733
+ /**
2734
+ * True when the user edited the proposed content in the permission dialog before accepting
2735
+ */
2736
+ userModified?: boolean;
2737
+ }
2738
+ export interface GlobOutput {
2739
+ /**
2740
+ * Time taken to execute the search in milliseconds
2741
+ */
2742
+ durationMs: number;
2743
+ /**
2744
+ * Total number of files found
2745
+ */
2746
+ numFiles: number;
2747
+ /**
2748
+ * Array of file paths that match the pattern
2749
+ */
2750
+ filenames: string[];
2751
+ /**
2752
+ * Whether results were truncated (limited to 100 files)
2753
+ */
2754
+ truncated: boolean;
2755
+ }
2756
+ export interface GrepOutput {
2757
+ mode?: "content" | "files_with_matches" | "count";
2758
+ numFiles: number;
2759
+ filenames: string[];
2760
+ content?: string;
2761
+ numLines?: number;
2762
+ numMatches?: number;
2763
+ appliedLimit?: number;
2764
+ appliedOffset?: number;
2765
+ }
2766
+ export interface TaskStopOutput {
2767
+ /**
2768
+ * Status message about the operation
2769
+ */
2770
+ message: string;
2771
+ /**
2772
+ * The ID of the task that was stopped
2773
+ */
2774
+ task_id: string;
2775
+ /**
2776
+ * The type of the task that was stopped
2777
+ */
2778
+ task_type: string;
2779
+ /**
2780
+ * The command or description of the stopped task
2781
+ */
2782
+ command?: string;
2783
+ }
2784
+ export interface NotebookEditOutput {
2785
+ /**
2786
+ * The new source code that was written to the cell
2787
+ */
2788
+ new_source: string;
2789
+ /**
2790
+ * The ID of the cell that was edited
2791
+ */
2792
+ cell_id?: string;
2793
+ /**
2794
+ * The type of the cell
2795
+ */
2796
+ cell_type: "code" | "markdown";
2797
+ /**
2798
+ * The programming language of the notebook
2799
+ */
2800
+ language: string;
2801
+ /**
2802
+ * The edit mode that was used
2803
+ */
2804
+ edit_mode: string;
2805
+ /**
2806
+ * Error message if the operation failed
2807
+ */
2808
+ error?: string;
2809
+ /**
2810
+ * The path to the notebook file
2811
+ */
2812
+ notebook_path: string;
2813
+ /**
2814
+ * The original notebook content before modification
2815
+ */
2816
+ original_file: string;
2817
+ /**
2818
+ * The updated notebook content after modification
2819
+ */
2820
+ updated_file: string;
2821
+ }
2822
+ export interface ReadMcpResourceOutput {
2823
+ contents: {
2824
+ /**
2825
+ * Resource URI
2826
+ */
2827
+ uri: string;
2828
+ /**
2829
+ * MIME type of the content
2830
+ */
2831
+ mimeType?: string;
2832
+ /**
2833
+ * Text content of the resource
2834
+ */
2835
+ text?: string;
2836
+ /**
2837
+ * Path where binary blob content was saved
2838
+ */
2839
+ blobSavedTo?: string;
2840
+ }[];
2841
+ /**
2842
+ * Human-readable error when the server could not read the resource
2843
+ */
2844
+ error?: string;
2845
+ }
2846
+ export interface TodoWriteOutput {
2847
+ /**
2848
+ * The todo list before the update
2849
+ */
2850
+ oldTodos: {
2851
+ content: string;
2852
+ status: "pending" | "in_progress" | "completed";
2853
+ activeForm: string;
2854
+ }[];
2855
+ /**
2856
+ * The todo list after the update
2857
+ */
2858
+ newTodos: {
2859
+ content: string;
2860
+ status: "pending" | "in_progress" | "completed";
2861
+ activeForm: string;
2862
+ }[];
2863
+ }
2864
+ export interface WebFetchOutput {
2865
+ /**
2866
+ * Size of the fetched content in bytes
2867
+ */
2868
+ bytes: number;
2869
+ /**
2870
+ * HTTP response code
2871
+ */
2872
+ code: number;
2873
+ /**
2874
+ * HTTP response code text
2875
+ */
2876
+ codeText: string;
2877
+ /**
2878
+ * Processed result from applying the prompt to the content
2879
+ */
2880
+ result: string;
2881
+ /**
2882
+ * Time taken to fetch and process the content
2883
+ */
2884
+ durationMs: number;
2885
+ /**
2886
+ * The URL that was fetched
2887
+ */
2888
+ url: string;
2889
+ artifactRead?: {
2890
+ slug: string;
2891
+ ver: string;
2892
+ };
2893
+ }
2894
+ export interface WebSearchOutput {
2895
+ /**
2896
+ * The search query that was executed
2897
+ */
2898
+ query: string;
2899
+ /**
2900
+ * Search results and/or text commentary from the model
2901
+ */
2902
+ results: (
2903
+ | {
2904
+ /**
2905
+ * ID of the tool use
2906
+ */
2907
+ tool_use_id: string;
2908
+ /**
2909
+ * Array of search hits
2910
+ */
2911
+ content: {
2912
+ /**
2913
+ * The title of the search result
2914
+ */
2915
+ title: string;
2916
+ /**
2917
+ * The URL of the search result
2918
+ */
2919
+ url: string;
2920
+ }[];
2921
+ }
2922
+ | string
2923
+ )[];
2924
+ /**
2925
+ * Time taken to complete the search operation
2926
+ */
2927
+ durationSeconds: number;
2928
+ /**
2929
+ * Number of web searches performed
2930
+ */
2931
+ searchCount?: number;
2932
+ }
2933
+ export interface AskUserQuestionOutput {
2934
+ /**
2935
+ * The questions that were asked
2936
+ */
2937
+ questions: {
2938
+ /**
2939
+ * 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?"
2940
+ */
2941
+ question: string;
2942
+ /**
2943
+ * Very short label displayed as a chip/tag (max 12 chars). Examples: "Auth method", "Library", "Approach".
2944
+ */
2945
+ header: string;
2946
+ /**
2947
+ * 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.
2948
+ *
2949
+ * @minItems 2
2950
+ * @maxItems 4
2951
+ */
2952
+ options:
2953
+ | [
2954
+ {
2955
+ /**
2956
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
2957
+ */
2958
+ label: string;
2959
+ /**
2960
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
2961
+ */
2962
+ description: string;
2963
+ /**
2964
+ * 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.
2965
+ */
2966
+ preview?: string;
2967
+ },
2968
+ {
2969
+ /**
2970
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
2971
+ */
2972
+ label: string;
2973
+ /**
2974
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
2975
+ */
2976
+ description: string;
2977
+ /**
2978
+ * 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.
2979
+ */
2980
+ preview?: string;
2981
+ }
2982
+ ]
2983
+ | [
2984
+ {
2985
+ /**
2986
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
2987
+ */
2988
+ label: string;
2989
+ /**
2990
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
2991
+ */
2992
+ description: string;
2993
+ /**
2994
+ * 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.
2995
+ */
2996
+ preview?: string;
2997
+ },
2998
+ {
2999
+ /**
3000
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
3001
+ */
3002
+ label: string;
3003
+ /**
3004
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
3005
+ */
3006
+ description: string;
3007
+ /**
3008
+ * 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.
3009
+ */
3010
+ preview?: string;
3011
+ },
3012
+ {
3013
+ /**
3014
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
3015
+ */
3016
+ label: string;
3017
+ /**
3018
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
3019
+ */
3020
+ description: string;
3021
+ /**
3022
+ * 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.
3023
+ */
3024
+ preview?: string;
3025
+ }
3026
+ ]
3027
+ | [
3028
+ {
3029
+ /**
3030
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
3031
+ */
3032
+ label: string;
3033
+ /**
3034
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
3035
+ */
3036
+ description: string;
3037
+ /**
3038
+ * 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.
3039
+ */
3040
+ preview?: string;
3041
+ },
3042
+ {
3043
+ /**
3044
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
3045
+ */
3046
+ label: string;
3047
+ /**
3048
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
3049
+ */
3050
+ description: string;
3051
+ /**
3052
+ * 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.
3053
+ */
3054
+ preview?: string;
3055
+ },
3056
+ {
3057
+ /**
3058
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
3059
+ */
3060
+ label: string;
3061
+ /**
3062
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
3063
+ */
3064
+ description: string;
3065
+ /**
3066
+ * 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.
3067
+ */
3068
+ preview?: string;
3069
+ },
3070
+ {
3071
+ /**
3072
+ * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
3073
+ */
3074
+ label: string;
3075
+ /**
3076
+ * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
3077
+ */
3078
+ description: string;
3079
+ /**
3080
+ * 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.
3081
+ */
3082
+ preview?: string;
3083
+ }
3084
+ ];
3085
+ /**
3086
+ * Set to true to allow the user to select multiple options instead of just one. Use when choices are not mutually exclusive.
3087
+ */
3088
+ multiSelect: boolean;
3089
+ }[];
3090
+ /**
3091
+ * The answers provided by the user (question text -> answer string; multi-select answers are comma-separated)
3092
+ */
3093
+ answers: {
3094
+ [k: string]: string;
3095
+ };
3096
+ /**
3097
+ * Freeform text the user typed instead of selecting a structured option
3098
+ */
3099
+ response?: string;
3100
+ /**
3101
+ * Optional per-question annotations from the user (e.g., notes on preview selections). Keyed by question text.
3102
+ */
3103
+ annotations?: {
3104
+ [k: string]: {
3105
+ /**
3106
+ * The preview content of the selected option, if the question used previews.
3107
+ */
3108
+ preview?: string;
3109
+ /**
3110
+ * Free-text notes the user added to their selection.
3111
+ */
3112
+ notes?: string;
3113
+ };
3114
+ };
3115
+ }
3116
+ export interface EnterWorktreeOutput {
3117
+ worktreePath: string;
3118
+ worktreeBranch?: string;
3119
+ message: string;
3120
+ }
3121
+ export interface ExitWorktreeOutput {
3122
+ action: "keep" | "remove";
3123
+ originalCwd: string;
3124
+ worktreePath: string;
3125
+ worktreeBranch?: string;
3126
+ tmuxSessionName?: string;
3127
+ discardedFiles?: number;
3128
+ discardedCommits?: number;
3129
+ message: string;
3130
+ }
3131
+ export interface TaskCreateOutput {
3132
+ task: {
3133
+ id: string;
3134
+ subject: string;
3135
+ };
3136
+ }
3137
+ export interface TaskGetOutput {
3138
+ task: {
3139
+ id: string;
3140
+ subject: string;
3141
+ description: string;
3142
+ status: "pending" | "in_progress" | "completed";
3143
+ blocks: string[];
3144
+ blockedBy: string[];
3145
+ } | null;
3146
+ }
3147
+ export interface TaskUpdateOutput {
3148
+ success: boolean;
3149
+ taskId: string;
3150
+ updatedFields: string[];
3151
+ error?: string;
3152
+ statusChange?: {
3153
+ from: string;
3154
+ to: string;
3155
+ };
3156
+ }
3157
+ export interface TaskListOutput {
3158
+ tasks: {
3159
+ id: string;
3160
+ subject: string;
3161
+ status: "pending" | "in_progress" | "completed";
3162
+ owner?: string;
3163
+ blockedBy: string[];
3164
+ }[];
3165
+ }
3166
+ export interface ArtifactOutput {
3167
+ url: string;
3168
+ path: string;
3169
+ title?: string;
3170
+ version?: string;
3171
+ mcpDropped?: string;
3172
+ }
3173
+ export interface RemoteTriggerOutput {
3174
+ status: number;
3175
+ json: string;
3176
+ summary?: string;
3177
+ }
3178
+ export interface ShowOnboardingRolePickerOutput {
3179
+ role?: string;
3180
+ dismissed?: boolean;
3181
+ }
3182
+ export interface ScheduleWakeupOutput {
3183
+ /**
3184
+ * Epoch ms timestamp when the next wakeup will fire
3185
+ */
3186
+ scheduledFor: number;
3187
+ /**
3188
+ * Actual delay used after clamping to runtime bounds
3189
+ */
3190
+ clampedDelaySeconds: number;
3191
+ /**
3192
+ * True if the requested delaySeconds was outside [60, 3600]
3193
+ */
3194
+ wasClamped: boolean;
3195
+ }
3196
+ export interface MonitorOutput {
3197
+ /**
3198
+ * ID of the background monitor task.
3199
+ */
3200
+ taskId: string;
3201
+ /**
3202
+ * Timeout deadline in milliseconds (0 when persistent).
3203
+ */
3204
+ timeoutMs: number;
3205
+ /**
3206
+ * No timeout — runs until TaskStop or session end.
3207
+ */
3208
+ persistent?: boolean;
3209
+ }
3210
+ export interface EnterPlanModeOutput {
3211
+ /**
3212
+ * Confirmation that plan mode was entered
3213
+ */
3214
+ message: string;
3215
+ }
3216
+ export interface REPLOutput {
3217
+ /**
3218
+ * The code that was executed
3219
+ */
3220
+ code: string;
3221
+ /**
3222
+ * Return value from the code execution
3223
+ */
3224
+ result: {
3225
+ [k: string]: unknown;
3226
+ };
3227
+ /**
3228
+ * Captured console.log output
3229
+ */
3230
+ stdout: string;
3231
+ /**
3232
+ * Captured console.error output
3233
+ */
3234
+ stderr: string;
3235
+ /**
3236
+ * Error message if execution failed
3237
+ */
3238
+ error?: string;
3239
+ /**
3240
+ * Names of tools registered during this execution
3241
+ */
3242
+ registeredTools?: string[];
3243
+ /**
3244
+ * Images returned by inner Read calls — surfaced as image content blocks
3245
+ */
3246
+ images?: {
3247
+ base64: string;
3248
+ mediaType: string;
3249
+ }[];
3250
+ /**
3251
+ * PDFs returned by inner Read calls — surfaced as document content blocks
3252
+ */
3253
+ documents?: {
3254
+ base64: string;
3255
+ }[];
3256
+ }
3257
+ export interface WorkflowOutput {
3258
+ status: "async_launched" | "remote_launched";
3259
+ taskId: string;
3260
+ /**
3261
+ * TaskType of the registered background task — 'local_workflow' for in-process runs, 'remote_agent' when remote:true dispatches to CCR. Set on all new writes; absent only on transcripts written before this field existed.
3262
+ */
3263
+ taskType?: "local_workflow" | "remote_agent";
3264
+ /**
3265
+ * meta.name from the workflow script — same value as task_started.workflow_name. Set on all new writes; absent only on transcripts written before this field existed.
3266
+ */
3267
+ workflowName?: string;
3268
+ /**
3269
+ * Local workflow run identifier for resumeFromRunId. Absent for remote_launched (the CCR session URL is the resume handle there) and on transcripts written before this field existed.
3270
+ */
3271
+ runId?: string;
3272
+ summary?: string;
3273
+ /**
3274
+ * Directory where subagent transcripts are written during execution
3275
+ */
3276
+ transcriptDir?: string;
3277
+ /**
3278
+ * Path to the persisted workflow script for this invocation. Editable via Write/Edit; pass back as `scriptPath` to re-run without resending the script.
3279
+ */
3280
+ scriptPath?: string;
3281
+ /**
3282
+ * CCR session URL when status is remote_launched
3283
+ */
3284
+ sessionUrl?: string;
3285
+ /**
3286
+ * Non-blocking heads-up (e.g. local git state diverges from the pushed branch the cloud session will clone)
3287
+ */
3288
+ warning?: string;
3289
+ /**
3290
+ * Set if syntax check failed
3291
+ */
3292
+ error?: string;
3293
+ }
3294
+ export interface CronCreateOutput {
3295
+ id: string;
3296
+ humanSchedule: string;
3297
+ recurring: boolean;
3298
+ durable?: boolean;
3299
+ }
3300
+ export interface CronDeleteOutput {
3301
+ id: string;
3302
+ }
3303
+ export interface CronListOutput {
3304
+ jobs: {
3305
+ id: string;
3306
+ cron: string;
3307
+ humanSchedule: string;
3308
+ prompt: string;
3309
+ recurring?: boolean;
3310
+ durable?: boolean;
3311
+ }[];
3312
+ }
3313
+ export interface PushNotificationOutput {
3314
+ message: string;
3315
+ pushSent?: boolean;
3316
+ localSent?: boolean;
3317
+ disabledReason?: "config_off" | "user_present" | "no_transport";
3318
+ idleSec?: number;
3319
+ hasFocus?: boolean;
3320
+ /**
3321
+ * ISO timestamp captured at tool execution on the emitting process. Optional — resumed sessions replay pre-sentAt outputs verbatim.
3322
+ */
3323
+ sentAt?: string;
3324
+ }