sdk-tools.d.ts 114 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719
  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. * JSON Schema definitions for Claude CLI tool inputs
  9. */
  10. export type ToolInputSchemas =
  11. | AgentInput
  12. | BashInput
  13. | TaskOutputInput
  14. | ExitPlanModeInput
  15. | FileEditInput
  16. | FileReadInput
  17. | FileWriteInput
  18. | GlobInput
  19. | GrepInput
  20. | TaskStopInput
  21. | ListMcpResourcesInput
  22. | McpInput
  23. | NotebookEditInput
  24. | ReadMcpResourceInput
  25. | TodoWriteInput
  26. | WebFetchInput
  27. | WebSearchInput
  28. | AskUserQuestionInput
  29. | ConfigInput
  30. | EnterWorktreeInput
  31. | ExitWorktreeInput
  32. | ToolOutputSchemas;
  33. export type ToolOutputSchemas =
  34. | AgentOutput
  35. | BashOutput
  36. | ExitPlanModeOutput
  37. | FileEditOutput
  38. | FileReadOutput
  39. | FileWriteOutput
  40. | GlobOutput
  41. | GrepOutput
  42. | TaskStopOutput
  43. | ListMcpResourcesOutput
  44. | McpOutput
  45. | NotebookEditOutput
  46. | ReadMcpResourceOutput
  47. | TodoWriteOutput
  48. | WebFetchOutput
  49. | WebSearchOutput
  50. | AskUserQuestionOutput
  51. | ConfigOutput
  52. | EnterWorktreeOutput
  53. | ExitWorktreeOutput;
  54. export type AgentOutput =
  55. | {
  56. agentId: string;
  57. agentType?: string;
  58. content: {
  59. type: "text";
  60. text: string;
  61. }[];
  62. totalToolUseCount: number;
  63. totalDurationMs: number;
  64. totalTokens: number;
  65. usage: {
  66. input_tokens: number;
  67. output_tokens: number;
  68. cache_creation_input_tokens: number | null;
  69. cache_read_input_tokens: number | null;
  70. server_tool_use: {
  71. web_search_requests: number;
  72. web_fetch_requests: number;
  73. } | null;
  74. service_tier: ("standard" | "priority" | "batch") | null;
  75. cache_creation: {
  76. ephemeral_1h_input_tokens: number;
  77. ephemeral_5m_input_tokens: number;
  78. } | null;
  79. };
  80. status: "completed";
  81. prompt: string;
  82. }
  83. | {
  84. status: "async_launched";
  85. /**
  86. * The ID of the async agent
  87. */
  88. agentId: string;
  89. /**
  90. * The description of the task
  91. */
  92. description: string;
  93. /**
  94. * The prompt for the agent
  95. */
  96. prompt: string;
  97. /**
  98. * Path to the output file for checking agent progress
  99. */
  100. outputFile: string;
  101. /**
  102. * Whether the calling agent has Read/Bash tools to check progress
  103. */
  104. canReadOutputFile?: boolean;
  105. };
  106. export type FileReadOutput =
  107. | {
  108. type: "text";
  109. file: {
  110. /**
  111. * The path to the file that was read
  112. */
  113. filePath: string;
  114. /**
  115. * The content of the file
  116. */
  117. content: string;
  118. /**
  119. * Number of lines in the returned content
  120. */
  121. numLines: number;
  122. /**
  123. * The starting line number
  124. */
  125. startLine: number;
  126. /**
  127. * Total number of lines in the file
  128. */
  129. totalLines: number;
  130. };
  131. }
  132. | {
  133. type: "image";
  134. file: {
  135. /**
  136. * Base64-encoded image data
  137. */
  138. base64: string;
  139. /**
  140. * The MIME type of the image
  141. */
  142. type: "image/jpeg" | "image/png" | "image/gif" | "image/webp";
  143. /**
  144. * Original file size in bytes
  145. */
  146. originalSize: number;
  147. /**
  148. * Image dimension info for coordinate mapping
  149. */
  150. dimensions?: {
  151. /**
  152. * Original image width in pixels
  153. */
  154. originalWidth?: number;
  155. /**
  156. * Original image height in pixels
  157. */
  158. originalHeight?: number;
  159. /**
  160. * Displayed image width in pixels (after resizing)
  161. */
  162. displayWidth?: number;
  163. /**
  164. * Displayed image height in pixels (after resizing)
  165. */
  166. displayHeight?: number;
  167. };
  168. };
  169. }
  170. | {
  171. type: "notebook";
  172. file: {
  173. /**
  174. * The path to the notebook file
  175. */
  176. filePath: string;
  177. /**
  178. * Array of notebook cells
  179. */
  180. cells: unknown[];
  181. };
  182. }
  183. | {
  184. type: "pdf";
  185. file: {
  186. /**
  187. * The path to the PDF file
  188. */
  189. filePath: string;
  190. /**
  191. * Base64-encoded PDF data
  192. */
  193. base64: string;
  194. /**
  195. * Original file size in bytes
  196. */
  197. originalSize: number;
  198. };
  199. }
  200. | {
  201. type: "parts";
  202. file: {
  203. /**
  204. * The path to the PDF file
  205. */
  206. filePath: string;
  207. /**
  208. * Original file size in bytes
  209. */
  210. originalSize: number;
  211. /**
  212. * Number of pages extracted
  213. */
  214. count: number;
  215. /**
  216. * Directory containing extracted page images
  217. */
  218. outputDir: string;
  219. };
  220. }
  221. | {
  222. type: "file_unchanged";
  223. file: {
  224. /**
  225. * The path to the file
  226. */
  227. filePath: string;
  228. };
  229. };
  230. export type ListMcpResourcesOutput = {
  231. /**
  232. * Resource URI
  233. */
  234. uri: string;
  235. /**
  236. * Resource name
  237. */
  238. name: string;
  239. /**
  240. * MIME type of the resource
  241. */
  242. mimeType?: string;
  243. /**
  244. * Resource description
  245. */
  246. description?: string;
  247. /**
  248. * Server that provides this resource
  249. */
  250. server: string;
  251. }[];
  252. /**
  253. * MCP tool execution result
  254. */
  255. export type McpOutput = string;
  256. export interface AgentInput {
  257. /**
  258. * A short (3-5 word) description of the task
  259. */
  260. description: string;
  261. /**
  262. * The task for the agent to perform
  263. */
  264. prompt: string;
  265. /**
  266. * The type of specialized agent to use for this task
  267. */
  268. subagent_type?: string;
  269. /**
  270. * 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.
  271. */
  272. model?: "sonnet" | "opus" | "haiku";
  273. /**
  274. * Set to true to run this agent in the background. You will be notified when it completes.
  275. */
  276. run_in_background?: boolean;
  277. /**
  278. * Name for the spawned agent. Makes it addressable via SendMessage({to: name}) while running.
  279. */
  280. name?: string;
  281. /**
  282. * Team name for spawning. Uses current team context if omitted.
  283. */
  284. team_name?: string;
  285. /**
  286. * Permission mode for spawned teammate (e.g., "plan" to require plan approval).
  287. */
  288. mode?: "acceptEdits" | "bypassPermissions" | "default" | "dontAsk" | "plan";
  289. /**
  290. * Isolation mode. "worktree" creates a temporary git worktree so the agent works on an isolated copy of the repo.
  291. */
  292. isolation?: "worktree";
  293. }
  294. export interface BashInput {
  295. /**
  296. * The command to execute
  297. */
  298. command: string;
  299. /**
  300. * Optional timeout in milliseconds (max 600000)
  301. */
  302. timeout?: number;
  303. /**
  304. * 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.
  305. *
  306. * For simple commands (git, npm, standard CLI tools), keep it brief (5-10 words):
  307. * - ls → "List files in current directory"
  308. * - git status → "Show working tree status"
  309. * - npm install → "Install package dependencies"
  310. *
  311. * For commands that are harder to parse at a glance (piped commands, obscure flags, etc.), add enough context to clarify what it does:
  312. * - find . -name "*.tmp" -exec rm {} \; → "Find and delete all .tmp files recursively"
  313. * - git reset --hard origin/main → "Discard all local changes and match remote main"
  314. * - curl -s url | jq '.data[]' → "Fetch JSON from URL and extract data array elements"
  315. */
  316. description?: string;
  317. /**
  318. * Set to true to run this command in the background. Use Read to read the output later.
  319. */
  320. run_in_background?: boolean;
  321. /**
  322. * Set this to true to dangerously override sandbox mode and run commands without sandboxing.
  323. */
  324. dangerouslyDisableSandbox?: boolean;
  325. }
  326. export interface TaskOutputInput {
  327. /**
  328. * The task ID to get output from
  329. */
  330. task_id: string;
  331. /**
  332. * Whether to wait for completion
  333. */
  334. block: boolean;
  335. /**
  336. * Max wait time in ms
  337. */
  338. timeout: number;
  339. }
  340. export interface ExitPlanModeInput {
  341. /**
  342. * Prompt-based permissions needed to implement the plan. These describe categories of actions rather than specific commands.
  343. */
  344. allowedPrompts?: {
  345. /**
  346. * The tool this prompt applies to
  347. */
  348. tool: "Bash";
  349. /**
  350. * Semantic description of the action, e.g. "run tests", "install dependencies"
  351. */
  352. prompt: string;
  353. }[];
  354. [k: string]: unknown;
  355. }
  356. export interface FileEditInput {
  357. /**
  358. * The absolute path to the file to modify
  359. */
  360. file_path: string;
  361. /**
  362. * The text to replace
  363. */
  364. old_string: string;
  365. /**
  366. * The text to replace it with (must be different from old_string)
  367. */
  368. new_string: string;
  369. /**
  370. * Replace all occurrences of old_string (default false)
  371. */
  372. replace_all?: boolean;
  373. }
  374. export interface FileReadInput {
  375. /**
  376. * The absolute path to the file to read
  377. */
  378. file_path: string;
  379. /**
  380. * The line number to start reading from. Only provide if the file is too large to read at once
  381. */
  382. offset?: number;
  383. /**
  384. * The number of lines to read. Only provide if the file is too large to read at once.
  385. */
  386. limit?: number;
  387. /**
  388. * Page range for PDF files (e.g., "1-5", "3", "10-20"). Only applicable to PDF files. Maximum 20 pages per request.
  389. */
  390. pages?: string;
  391. }
  392. export interface FileWriteInput {
  393. /**
  394. * The absolute path to the file to write (must be absolute, not relative)
  395. */
  396. file_path: string;
  397. /**
  398. * The content to write to the file
  399. */
  400. content: string;
  401. }
  402. export interface GlobInput {
  403. /**
  404. * The glob pattern to match files against
  405. */
  406. pattern: string;
  407. /**
  408. * 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.
  409. */
  410. path?: string;
  411. }
  412. export interface GrepInput {
  413. /**
  414. * The regular expression pattern to search for in file contents
  415. */
  416. pattern: string;
  417. /**
  418. * File or directory to search in (rg PATH). Defaults to current working directory.
  419. */
  420. path?: string;
  421. /**
  422. * Glob pattern to filter files (e.g. "*.js", "*.{ts,tsx}") - maps to rg --glob
  423. */
  424. glob?: string;
  425. /**
  426. * 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".
  427. */
  428. output_mode?: "content" | "files_with_matches" | "count";
  429. /**
  430. * Number of lines to show before each match (rg -B). Requires output_mode: "content", ignored otherwise.
  431. */
  432. "-B"?: number;
  433. /**
  434. * Number of lines to show after each match (rg -A). Requires output_mode: "content", ignored otherwise.
  435. */
  436. "-A"?: number;
  437. /**
  438. * Alias for context.
  439. */
  440. "-C"?: number;
  441. /**
  442. * Number of lines to show before and after each match (rg -C). Requires output_mode: "content", ignored otherwise.
  443. */
  444. context?: number;
  445. /**
  446. * Show line numbers in output (rg -n). Requires output_mode: "content", ignored otherwise. Defaults to true.
  447. */
  448. "-n"?: boolean;
  449. /**
  450. * Case insensitive search (rg -i)
  451. */
  452. "-i"?: boolean;
  453. /**
  454. * File type to search (rg --type). Common types: js, py, rust, go, java, etc. More efficient than include for standard file types.
  455. */
  456. type?: string;
  457. /**
  458. * 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).
  459. */
  460. head_limit?: number;
  461. /**
  462. * Skip first N lines/entries before applying head_limit, equivalent to "| tail -n +N | head -N". Works across all output modes. Defaults to 0.
  463. */
  464. offset?: number;
  465. /**
  466. * Enable multiline mode where . matches newlines and patterns can span lines (rg -U --multiline-dotall). Default: false.
  467. */
  468. multiline?: boolean;
  469. }
  470. export interface TaskStopInput {
  471. /**
  472. * The ID of the background task to stop
  473. */
  474. task_id?: string;
  475. /**
  476. * Deprecated: use task_id instead
  477. */
  478. shell_id?: string;
  479. }
  480. export interface ListMcpResourcesInput {
  481. /**
  482. * Optional server name to filter resources by
  483. */
  484. server?: string;
  485. }
  486. export interface McpInput {
  487. [k: string]: unknown;
  488. }
  489. export interface NotebookEditInput {
  490. /**
  491. * The absolute path to the Jupyter notebook file to edit (must be absolute, not relative)
  492. */
  493. notebook_path: string;
  494. /**
  495. * 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.
  496. */
  497. cell_id?: string;
  498. /**
  499. * The new source for the cell
  500. */
  501. new_source: string;
  502. /**
  503. * 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.
  504. */
  505. cell_type?: "code" | "markdown";
  506. /**
  507. * The type of edit to make (replace, insert, delete). Defaults to replace.
  508. */
  509. edit_mode?: "replace" | "insert" | "delete";
  510. }
  511. export interface ReadMcpResourceInput {
  512. /**
  513. * The MCP server name
  514. */
  515. server: string;
  516. /**
  517. * The resource URI to read
  518. */
  519. uri: string;
  520. }
  521. export interface TodoWriteInput {
  522. /**
  523. * The updated todo list
  524. */
  525. todos: {
  526. content: string;
  527. status: "pending" | "in_progress" | "completed";
  528. activeForm: string;
  529. }[];
  530. }
  531. export interface WebFetchInput {
  532. /**
  533. * The URL to fetch content from
  534. */
  535. url: string;
  536. /**
  537. * The prompt to run on the fetched content
  538. */
  539. prompt: string;
  540. }
  541. export interface WebSearchInput {
  542. /**
  543. * The search query to use
  544. */
  545. query: string;
  546. /**
  547. * Only include search results from these domains
  548. */
  549. allowed_domains?: string[];
  550. /**
  551. * Never include search results from these domains
  552. */
  553. blocked_domains?: string[];
  554. }
  555. export interface AskUserQuestionInput {
  556. /**
  557. * Questions to ask the user (1-4 questions)
  558. *
  559. * @minItems 1
  560. * @maxItems 4
  561. */
  562. questions:
  563. | [
  564. {
  565. /**
  566. * 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?"
  567. */
  568. question: string;
  569. /**
  570. * Very short label displayed as a chip/tag (max 12 chars). Examples: "Auth method", "Library", "Approach".
  571. */
  572. header: string;
  573. /**
  574. * 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.
  575. *
  576. * @minItems 2
  577. * @maxItems 4
  578. */
  579. options:
  580. | [
  581. {
  582. /**
  583. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  584. */
  585. label: string;
  586. /**
  587. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  588. */
  589. description: string;
  590. /**
  591. * 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.
  592. */
  593. preview?: string;
  594. },
  595. {
  596. /**
  597. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  598. */
  599. label: string;
  600. /**
  601. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  602. */
  603. description: string;
  604. /**
  605. * 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.
  606. */
  607. preview?: string;
  608. }
  609. ]
  610. | [
  611. {
  612. /**
  613. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  614. */
  615. label: string;
  616. /**
  617. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  618. */
  619. description: string;
  620. /**
  621. * 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.
  622. */
  623. preview?: string;
  624. },
  625. {
  626. /**
  627. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  628. */
  629. label: string;
  630. /**
  631. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  632. */
  633. description: string;
  634. /**
  635. * 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.
  636. */
  637. preview?: string;
  638. },
  639. {
  640. /**
  641. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  642. */
  643. label: string;
  644. /**
  645. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  646. */
  647. description: string;
  648. /**
  649. * 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.
  650. */
  651. preview?: string;
  652. }
  653. ]
  654. | [
  655. {
  656. /**
  657. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  658. */
  659. label: string;
  660. /**
  661. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  662. */
  663. description: string;
  664. /**
  665. * 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.
  666. */
  667. preview?: string;
  668. },
  669. {
  670. /**
  671. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  672. */
  673. label: string;
  674. /**
  675. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  676. */
  677. description: string;
  678. /**
  679. * 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.
  680. */
  681. preview?: string;
  682. },
  683. {
  684. /**
  685. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  686. */
  687. label: string;
  688. /**
  689. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  690. */
  691. description: string;
  692. /**
  693. * 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.
  694. */
  695. preview?: string;
  696. },
  697. {
  698. /**
  699. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  700. */
  701. label: string;
  702. /**
  703. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  704. */
  705. description: string;
  706. /**
  707. * 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.
  708. */
  709. preview?: string;
  710. }
  711. ];
  712. /**
  713. * Set to true to allow the user to select multiple options instead of just one. Use when choices are not mutually exclusive.
  714. */
  715. multiSelect: boolean;
  716. }
  717. ]
  718. | [
  719. {
  720. /**
  721. * 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?"
  722. */
  723. question: string;
  724. /**
  725. * Very short label displayed as a chip/tag (max 12 chars). Examples: "Auth method", "Library", "Approach".
  726. */
  727. header: string;
  728. /**
  729. * 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.
  730. *
  731. * @minItems 2
  732. * @maxItems 4
  733. */
  734. options:
  735. | [
  736. {
  737. /**
  738. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  739. */
  740. label: string;
  741. /**
  742. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  743. */
  744. description: string;
  745. /**
  746. * 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.
  747. */
  748. preview?: string;
  749. },
  750. {
  751. /**
  752. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  753. */
  754. label: string;
  755. /**
  756. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  757. */
  758. description: string;
  759. /**
  760. * 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.
  761. */
  762. preview?: string;
  763. }
  764. ]
  765. | [
  766. {
  767. /**
  768. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  769. */
  770. label: string;
  771. /**
  772. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  773. */
  774. description: string;
  775. /**
  776. * 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.
  777. */
  778. preview?: string;
  779. },
  780. {
  781. /**
  782. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  783. */
  784. label: string;
  785. /**
  786. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  787. */
  788. description: string;
  789. /**
  790. * 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.
  791. */
  792. preview?: string;
  793. },
  794. {
  795. /**
  796. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  797. */
  798. label: string;
  799. /**
  800. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  801. */
  802. description: string;
  803. /**
  804. * 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.
  805. */
  806. preview?: string;
  807. }
  808. ]
  809. | [
  810. {
  811. /**
  812. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  813. */
  814. label: string;
  815. /**
  816. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  817. */
  818. description: string;
  819. /**
  820. * 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.
  821. */
  822. preview?: string;
  823. },
  824. {
  825. /**
  826. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  827. */
  828. label: string;
  829. /**
  830. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  831. */
  832. description: string;
  833. /**
  834. * 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.
  835. */
  836. preview?: string;
  837. },
  838. {
  839. /**
  840. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  841. */
  842. label: string;
  843. /**
  844. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  845. */
  846. description: string;
  847. /**
  848. * 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.
  849. */
  850. preview?: string;
  851. },
  852. {
  853. /**
  854. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  855. */
  856. label: string;
  857. /**
  858. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  859. */
  860. description: string;
  861. /**
  862. * 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.
  863. */
  864. preview?: string;
  865. }
  866. ];
  867. /**
  868. * Set to true to allow the user to select multiple options instead of just one. Use when choices are not mutually exclusive.
  869. */
  870. multiSelect: boolean;
  871. },
  872. {
  873. /**
  874. * 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?"
  875. */
  876. question: string;
  877. /**
  878. * Very short label displayed as a chip/tag (max 12 chars). Examples: "Auth method", "Library", "Approach".
  879. */
  880. header: string;
  881. /**
  882. * 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.
  883. *
  884. * @minItems 2
  885. * @maxItems 4
  886. */
  887. options:
  888. | [
  889. {
  890. /**
  891. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  892. */
  893. label: string;
  894. /**
  895. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  896. */
  897. description: string;
  898. /**
  899. * 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.
  900. */
  901. preview?: string;
  902. },
  903. {
  904. /**
  905. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  906. */
  907. label: string;
  908. /**
  909. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  910. */
  911. description: string;
  912. /**
  913. * 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.
  914. */
  915. preview?: string;
  916. }
  917. ]
  918. | [
  919. {
  920. /**
  921. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  922. */
  923. label: string;
  924. /**
  925. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  926. */
  927. description: string;
  928. /**
  929. * 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.
  930. */
  931. preview?: string;
  932. },
  933. {
  934. /**
  935. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  936. */
  937. label: string;
  938. /**
  939. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  940. */
  941. description: string;
  942. /**
  943. * 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.
  944. */
  945. preview?: string;
  946. },
  947. {
  948. /**
  949. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  950. */
  951. label: string;
  952. /**
  953. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  954. */
  955. description: string;
  956. /**
  957. * 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.
  958. */
  959. preview?: string;
  960. }
  961. ]
  962. | [
  963. {
  964. /**
  965. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  966. */
  967. label: string;
  968. /**
  969. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  970. */
  971. description: string;
  972. /**
  973. * 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.
  974. */
  975. preview?: string;
  976. },
  977. {
  978. /**
  979. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  980. */
  981. label: string;
  982. /**
  983. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  984. */
  985. description: string;
  986. /**
  987. * 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.
  988. */
  989. preview?: string;
  990. },
  991. {
  992. /**
  993. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  994. */
  995. label: string;
  996. /**
  997. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  998. */
  999. description: string;
  1000. /**
  1001. * 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.
  1002. */
  1003. preview?: string;
  1004. },
  1005. {
  1006. /**
  1007. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1008. */
  1009. label: string;
  1010. /**
  1011. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1012. */
  1013. description: string;
  1014. /**
  1015. * 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.
  1016. */
  1017. preview?: string;
  1018. }
  1019. ];
  1020. /**
  1021. * Set to true to allow the user to select multiple options instead of just one. Use when choices are not mutually exclusive.
  1022. */
  1023. multiSelect: boolean;
  1024. }
  1025. ]
  1026. | [
  1027. {
  1028. /**
  1029. * 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?"
  1030. */
  1031. question: string;
  1032. /**
  1033. * Very short label displayed as a chip/tag (max 12 chars). Examples: "Auth method", "Library", "Approach".
  1034. */
  1035. header: string;
  1036. /**
  1037. * 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.
  1038. *
  1039. * @minItems 2
  1040. * @maxItems 4
  1041. */
  1042. options:
  1043. | [
  1044. {
  1045. /**
  1046. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1047. */
  1048. label: string;
  1049. /**
  1050. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1051. */
  1052. description: string;
  1053. /**
  1054. * 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.
  1055. */
  1056. preview?: string;
  1057. },
  1058. {
  1059. /**
  1060. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1061. */
  1062. label: string;
  1063. /**
  1064. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1065. */
  1066. description: string;
  1067. /**
  1068. * 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.
  1069. */
  1070. preview?: string;
  1071. }
  1072. ]
  1073. | [
  1074. {
  1075. /**
  1076. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1077. */
  1078. label: string;
  1079. /**
  1080. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1081. */
  1082. description: string;
  1083. /**
  1084. * 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.
  1085. */
  1086. preview?: string;
  1087. },
  1088. {
  1089. /**
  1090. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1091. */
  1092. label: string;
  1093. /**
  1094. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1095. */
  1096. description: string;
  1097. /**
  1098. * 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.
  1099. */
  1100. preview?: string;
  1101. },
  1102. {
  1103. /**
  1104. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1105. */
  1106. label: string;
  1107. /**
  1108. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1109. */
  1110. description: string;
  1111. /**
  1112. * 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.
  1113. */
  1114. preview?: string;
  1115. }
  1116. ]
  1117. | [
  1118. {
  1119. /**
  1120. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1121. */
  1122. label: string;
  1123. /**
  1124. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1125. */
  1126. description: string;
  1127. /**
  1128. * 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.
  1129. */
  1130. preview?: string;
  1131. },
  1132. {
  1133. /**
  1134. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1135. */
  1136. label: string;
  1137. /**
  1138. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1139. */
  1140. description: string;
  1141. /**
  1142. * 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.
  1143. */
  1144. preview?: string;
  1145. },
  1146. {
  1147. /**
  1148. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1149. */
  1150. label: string;
  1151. /**
  1152. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1153. */
  1154. description: string;
  1155. /**
  1156. * 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.
  1157. */
  1158. preview?: string;
  1159. },
  1160. {
  1161. /**
  1162. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1163. */
  1164. label: string;
  1165. /**
  1166. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1167. */
  1168. description: string;
  1169. /**
  1170. * 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.
  1171. */
  1172. preview?: string;
  1173. }
  1174. ];
  1175. /**
  1176. * Set to true to allow the user to select multiple options instead of just one. Use when choices are not mutually exclusive.
  1177. */
  1178. multiSelect: boolean;
  1179. },
  1180. {
  1181. /**
  1182. * 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?"
  1183. */
  1184. question: string;
  1185. /**
  1186. * Very short label displayed as a chip/tag (max 12 chars). Examples: "Auth method", "Library", "Approach".
  1187. */
  1188. header: string;
  1189. /**
  1190. * 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.
  1191. *
  1192. * @minItems 2
  1193. * @maxItems 4
  1194. */
  1195. options:
  1196. | [
  1197. {
  1198. /**
  1199. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1200. */
  1201. label: string;
  1202. /**
  1203. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1204. */
  1205. description: string;
  1206. /**
  1207. * 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.
  1208. */
  1209. preview?: string;
  1210. },
  1211. {
  1212. /**
  1213. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1214. */
  1215. label: string;
  1216. /**
  1217. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1218. */
  1219. description: string;
  1220. /**
  1221. * 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.
  1222. */
  1223. preview?: string;
  1224. }
  1225. ]
  1226. | [
  1227. {
  1228. /**
  1229. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1230. */
  1231. label: string;
  1232. /**
  1233. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1234. */
  1235. description: string;
  1236. /**
  1237. * 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.
  1238. */
  1239. preview?: string;
  1240. },
  1241. {
  1242. /**
  1243. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1244. */
  1245. label: string;
  1246. /**
  1247. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1248. */
  1249. description: string;
  1250. /**
  1251. * 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.
  1252. */
  1253. preview?: string;
  1254. },
  1255. {
  1256. /**
  1257. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1258. */
  1259. label: string;
  1260. /**
  1261. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1262. */
  1263. description: string;
  1264. /**
  1265. * 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.
  1266. */
  1267. preview?: string;
  1268. }
  1269. ]
  1270. | [
  1271. {
  1272. /**
  1273. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1274. */
  1275. label: string;
  1276. /**
  1277. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1278. */
  1279. description: string;
  1280. /**
  1281. * 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.
  1282. */
  1283. preview?: string;
  1284. },
  1285. {
  1286. /**
  1287. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1288. */
  1289. label: string;
  1290. /**
  1291. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1292. */
  1293. description: string;
  1294. /**
  1295. * 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.
  1296. */
  1297. preview?: string;
  1298. },
  1299. {
  1300. /**
  1301. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1302. */
  1303. label: string;
  1304. /**
  1305. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1306. */
  1307. description: string;
  1308. /**
  1309. * 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.
  1310. */
  1311. preview?: string;
  1312. },
  1313. {
  1314. /**
  1315. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1316. */
  1317. label: string;
  1318. /**
  1319. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1320. */
  1321. description: string;
  1322. /**
  1323. * 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.
  1324. */
  1325. preview?: string;
  1326. }
  1327. ];
  1328. /**
  1329. * Set to true to allow the user to select multiple options instead of just one. Use when choices are not mutually exclusive.
  1330. */
  1331. multiSelect: boolean;
  1332. },
  1333. {
  1334. /**
  1335. * 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?"
  1336. */
  1337. question: string;
  1338. /**
  1339. * Very short label displayed as a chip/tag (max 12 chars). Examples: "Auth method", "Library", "Approach".
  1340. */
  1341. header: string;
  1342. /**
  1343. * 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.
  1344. *
  1345. * @minItems 2
  1346. * @maxItems 4
  1347. */
  1348. options:
  1349. | [
  1350. {
  1351. /**
  1352. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1353. */
  1354. label: string;
  1355. /**
  1356. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1357. */
  1358. description: string;
  1359. /**
  1360. * 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.
  1361. */
  1362. preview?: string;
  1363. },
  1364. {
  1365. /**
  1366. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1367. */
  1368. label: string;
  1369. /**
  1370. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1371. */
  1372. description: string;
  1373. /**
  1374. * 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.
  1375. */
  1376. preview?: string;
  1377. }
  1378. ]
  1379. | [
  1380. {
  1381. /**
  1382. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1383. */
  1384. label: string;
  1385. /**
  1386. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1387. */
  1388. description: string;
  1389. /**
  1390. * 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.
  1391. */
  1392. preview?: string;
  1393. },
  1394. {
  1395. /**
  1396. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1397. */
  1398. label: string;
  1399. /**
  1400. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1401. */
  1402. description: string;
  1403. /**
  1404. * 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.
  1405. */
  1406. preview?: string;
  1407. },
  1408. {
  1409. /**
  1410. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1411. */
  1412. label: string;
  1413. /**
  1414. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1415. */
  1416. description: string;
  1417. /**
  1418. * 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.
  1419. */
  1420. preview?: string;
  1421. }
  1422. ]
  1423. | [
  1424. {
  1425. /**
  1426. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1427. */
  1428. label: string;
  1429. /**
  1430. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1431. */
  1432. description: string;
  1433. /**
  1434. * 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.
  1435. */
  1436. preview?: string;
  1437. },
  1438. {
  1439. /**
  1440. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1441. */
  1442. label: string;
  1443. /**
  1444. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1445. */
  1446. description: string;
  1447. /**
  1448. * 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.
  1449. */
  1450. preview?: string;
  1451. },
  1452. {
  1453. /**
  1454. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1455. */
  1456. label: string;
  1457. /**
  1458. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1459. */
  1460. description: string;
  1461. /**
  1462. * 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.
  1463. */
  1464. preview?: string;
  1465. },
  1466. {
  1467. /**
  1468. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1469. */
  1470. label: string;
  1471. /**
  1472. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1473. */
  1474. description: string;
  1475. /**
  1476. * 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.
  1477. */
  1478. preview?: string;
  1479. }
  1480. ];
  1481. /**
  1482. * Set to true to allow the user to select multiple options instead of just one. Use when choices are not mutually exclusive.
  1483. */
  1484. multiSelect: boolean;
  1485. }
  1486. ]
  1487. | [
  1488. {
  1489. /**
  1490. * 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?"
  1491. */
  1492. question: string;
  1493. /**
  1494. * Very short label displayed as a chip/tag (max 12 chars). Examples: "Auth method", "Library", "Approach".
  1495. */
  1496. header: string;
  1497. /**
  1498. * 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.
  1499. *
  1500. * @minItems 2
  1501. * @maxItems 4
  1502. */
  1503. options:
  1504. | [
  1505. {
  1506. /**
  1507. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1508. */
  1509. label: string;
  1510. /**
  1511. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1512. */
  1513. description: string;
  1514. /**
  1515. * 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.
  1516. */
  1517. preview?: string;
  1518. },
  1519. {
  1520. /**
  1521. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1522. */
  1523. label: string;
  1524. /**
  1525. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1526. */
  1527. description: string;
  1528. /**
  1529. * 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.
  1530. */
  1531. preview?: string;
  1532. }
  1533. ]
  1534. | [
  1535. {
  1536. /**
  1537. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1538. */
  1539. label: string;
  1540. /**
  1541. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1542. */
  1543. description: string;
  1544. /**
  1545. * 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.
  1546. */
  1547. preview?: string;
  1548. },
  1549. {
  1550. /**
  1551. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1552. */
  1553. label: string;
  1554. /**
  1555. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1556. */
  1557. description: string;
  1558. /**
  1559. * 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.
  1560. */
  1561. preview?: string;
  1562. },
  1563. {
  1564. /**
  1565. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1566. */
  1567. label: string;
  1568. /**
  1569. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1570. */
  1571. description: string;
  1572. /**
  1573. * 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.
  1574. */
  1575. preview?: string;
  1576. }
  1577. ]
  1578. | [
  1579. {
  1580. /**
  1581. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1582. */
  1583. label: string;
  1584. /**
  1585. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1586. */
  1587. description: string;
  1588. /**
  1589. * 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.
  1590. */
  1591. preview?: string;
  1592. },
  1593. {
  1594. /**
  1595. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1596. */
  1597. label: string;
  1598. /**
  1599. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1600. */
  1601. description: string;
  1602. /**
  1603. * 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.
  1604. */
  1605. preview?: string;
  1606. },
  1607. {
  1608. /**
  1609. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1610. */
  1611. label: string;
  1612. /**
  1613. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1614. */
  1615. description: string;
  1616. /**
  1617. * 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.
  1618. */
  1619. preview?: string;
  1620. },
  1621. {
  1622. /**
  1623. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1624. */
  1625. label: string;
  1626. /**
  1627. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1628. */
  1629. description: string;
  1630. /**
  1631. * 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.
  1632. */
  1633. preview?: string;
  1634. }
  1635. ];
  1636. /**
  1637. * Set to true to allow the user to select multiple options instead of just one. Use when choices are not mutually exclusive.
  1638. */
  1639. multiSelect: boolean;
  1640. },
  1641. {
  1642. /**
  1643. * 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?"
  1644. */
  1645. question: string;
  1646. /**
  1647. * Very short label displayed as a chip/tag (max 12 chars). Examples: "Auth method", "Library", "Approach".
  1648. */
  1649. header: string;
  1650. /**
  1651. * 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.
  1652. *
  1653. * @minItems 2
  1654. * @maxItems 4
  1655. */
  1656. options:
  1657. | [
  1658. {
  1659. /**
  1660. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1661. */
  1662. label: string;
  1663. /**
  1664. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1665. */
  1666. description: string;
  1667. /**
  1668. * 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.
  1669. */
  1670. preview?: string;
  1671. },
  1672. {
  1673. /**
  1674. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1675. */
  1676. label: string;
  1677. /**
  1678. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1679. */
  1680. description: string;
  1681. /**
  1682. * 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.
  1683. */
  1684. preview?: string;
  1685. }
  1686. ]
  1687. | [
  1688. {
  1689. /**
  1690. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1691. */
  1692. label: string;
  1693. /**
  1694. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1695. */
  1696. description: string;
  1697. /**
  1698. * 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.
  1699. */
  1700. preview?: string;
  1701. },
  1702. {
  1703. /**
  1704. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1705. */
  1706. label: string;
  1707. /**
  1708. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1709. */
  1710. description: string;
  1711. /**
  1712. * 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.
  1713. */
  1714. preview?: string;
  1715. },
  1716. {
  1717. /**
  1718. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1719. */
  1720. label: string;
  1721. /**
  1722. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1723. */
  1724. description: string;
  1725. /**
  1726. * 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.
  1727. */
  1728. preview?: string;
  1729. }
  1730. ]
  1731. | [
  1732. {
  1733. /**
  1734. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1735. */
  1736. label: string;
  1737. /**
  1738. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1739. */
  1740. description: string;
  1741. /**
  1742. * 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.
  1743. */
  1744. preview?: string;
  1745. },
  1746. {
  1747. /**
  1748. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1749. */
  1750. label: string;
  1751. /**
  1752. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1753. */
  1754. description: string;
  1755. /**
  1756. * 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.
  1757. */
  1758. preview?: string;
  1759. },
  1760. {
  1761. /**
  1762. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1763. */
  1764. label: string;
  1765. /**
  1766. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1767. */
  1768. description: string;
  1769. /**
  1770. * 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.
  1771. */
  1772. preview?: string;
  1773. },
  1774. {
  1775. /**
  1776. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1777. */
  1778. label: string;
  1779. /**
  1780. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1781. */
  1782. description: string;
  1783. /**
  1784. * 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.
  1785. */
  1786. preview?: string;
  1787. }
  1788. ];
  1789. /**
  1790. * Set to true to allow the user to select multiple options instead of just one. Use when choices are not mutually exclusive.
  1791. */
  1792. multiSelect: boolean;
  1793. },
  1794. {
  1795. /**
  1796. * 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?"
  1797. */
  1798. question: string;
  1799. /**
  1800. * Very short label displayed as a chip/tag (max 12 chars). Examples: "Auth method", "Library", "Approach".
  1801. */
  1802. header: string;
  1803. /**
  1804. * 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.
  1805. *
  1806. * @minItems 2
  1807. * @maxItems 4
  1808. */
  1809. options:
  1810. | [
  1811. {
  1812. /**
  1813. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1814. */
  1815. label: string;
  1816. /**
  1817. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1818. */
  1819. description: string;
  1820. /**
  1821. * 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.
  1822. */
  1823. preview?: string;
  1824. },
  1825. {
  1826. /**
  1827. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1828. */
  1829. label: string;
  1830. /**
  1831. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1832. */
  1833. description: string;
  1834. /**
  1835. * 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.
  1836. */
  1837. preview?: string;
  1838. }
  1839. ]
  1840. | [
  1841. {
  1842. /**
  1843. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1844. */
  1845. label: string;
  1846. /**
  1847. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1848. */
  1849. description: string;
  1850. /**
  1851. * 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.
  1852. */
  1853. preview?: string;
  1854. },
  1855. {
  1856. /**
  1857. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1858. */
  1859. label: string;
  1860. /**
  1861. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1862. */
  1863. description: string;
  1864. /**
  1865. * 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.
  1866. */
  1867. preview?: string;
  1868. },
  1869. {
  1870. /**
  1871. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1872. */
  1873. label: string;
  1874. /**
  1875. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1876. */
  1877. description: string;
  1878. /**
  1879. * 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.
  1880. */
  1881. preview?: string;
  1882. }
  1883. ]
  1884. | [
  1885. {
  1886. /**
  1887. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1888. */
  1889. label: string;
  1890. /**
  1891. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1892. */
  1893. description: string;
  1894. /**
  1895. * 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.
  1896. */
  1897. preview?: string;
  1898. },
  1899. {
  1900. /**
  1901. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1902. */
  1903. label: string;
  1904. /**
  1905. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1906. */
  1907. description: string;
  1908. /**
  1909. * 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.
  1910. */
  1911. preview?: string;
  1912. },
  1913. {
  1914. /**
  1915. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1916. */
  1917. label: string;
  1918. /**
  1919. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1920. */
  1921. description: string;
  1922. /**
  1923. * 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.
  1924. */
  1925. preview?: string;
  1926. },
  1927. {
  1928. /**
  1929. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1930. */
  1931. label: string;
  1932. /**
  1933. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1934. */
  1935. description: string;
  1936. /**
  1937. * 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.
  1938. */
  1939. preview?: string;
  1940. }
  1941. ];
  1942. /**
  1943. * Set to true to allow the user to select multiple options instead of just one. Use when choices are not mutually exclusive.
  1944. */
  1945. multiSelect: boolean;
  1946. },
  1947. {
  1948. /**
  1949. * 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?"
  1950. */
  1951. question: string;
  1952. /**
  1953. * Very short label displayed as a chip/tag (max 12 chars). Examples: "Auth method", "Library", "Approach".
  1954. */
  1955. header: string;
  1956. /**
  1957. * 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.
  1958. *
  1959. * @minItems 2
  1960. * @maxItems 4
  1961. */
  1962. options:
  1963. | [
  1964. {
  1965. /**
  1966. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1967. */
  1968. label: string;
  1969. /**
  1970. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1971. */
  1972. description: string;
  1973. /**
  1974. * 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.
  1975. */
  1976. preview?: string;
  1977. },
  1978. {
  1979. /**
  1980. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1981. */
  1982. label: string;
  1983. /**
  1984. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  1985. */
  1986. description: string;
  1987. /**
  1988. * 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.
  1989. */
  1990. preview?: string;
  1991. }
  1992. ]
  1993. | [
  1994. {
  1995. /**
  1996. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  1997. */
  1998. label: string;
  1999. /**
  2000. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  2001. */
  2002. description: string;
  2003. /**
  2004. * 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.
  2005. */
  2006. preview?: string;
  2007. },
  2008. {
  2009. /**
  2010. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  2011. */
  2012. label: string;
  2013. /**
  2014. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  2015. */
  2016. description: string;
  2017. /**
  2018. * 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.
  2019. */
  2020. preview?: string;
  2021. },
  2022. {
  2023. /**
  2024. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  2025. */
  2026. label: string;
  2027. /**
  2028. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  2029. */
  2030. description: string;
  2031. /**
  2032. * 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.
  2033. */
  2034. preview?: string;
  2035. }
  2036. ]
  2037. | [
  2038. {
  2039. /**
  2040. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  2041. */
  2042. label: string;
  2043. /**
  2044. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  2045. */
  2046. description: string;
  2047. /**
  2048. * 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.
  2049. */
  2050. preview?: string;
  2051. },
  2052. {
  2053. /**
  2054. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  2055. */
  2056. label: string;
  2057. /**
  2058. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  2059. */
  2060. description: string;
  2061. /**
  2062. * 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.
  2063. */
  2064. preview?: string;
  2065. },
  2066. {
  2067. /**
  2068. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  2069. */
  2070. label: string;
  2071. /**
  2072. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  2073. */
  2074. description: string;
  2075. /**
  2076. * 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.
  2077. */
  2078. preview?: string;
  2079. },
  2080. {
  2081. /**
  2082. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  2083. */
  2084. label: string;
  2085. /**
  2086. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  2087. */
  2088. description: string;
  2089. /**
  2090. * 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.
  2091. */
  2092. preview?: string;
  2093. }
  2094. ];
  2095. /**
  2096. * Set to true to allow the user to select multiple options instead of just one. Use when choices are not mutually exclusive.
  2097. */
  2098. multiSelect: boolean;
  2099. }
  2100. ];
  2101. /**
  2102. * User answers collected by the permission component
  2103. */
  2104. answers?: {
  2105. [k: string]: string;
  2106. };
  2107. /**
  2108. * Optional per-question annotations from the user (e.g., notes on preview selections). Keyed by question text.
  2109. */
  2110. annotations?: {
  2111. [k: string]: {
  2112. /**
  2113. * The preview content of the selected option, if the question used previews.
  2114. */
  2115. preview?: string;
  2116. /**
  2117. * Free-text notes the user added to their selection.
  2118. */
  2119. notes?: string;
  2120. };
  2121. };
  2122. /**
  2123. * Optional metadata for tracking and analytics purposes. Not displayed to user.
  2124. */
  2125. metadata?: {
  2126. /**
  2127. * Optional identifier for the source of this question (e.g., "remember" for /remember command). Used for analytics tracking.
  2128. */
  2129. source?: string;
  2130. };
  2131. }
  2132. export interface ConfigInput {
  2133. /**
  2134. * The setting key (e.g., "theme", "model", "permissions.defaultMode")
  2135. */
  2136. setting: string;
  2137. /**
  2138. * The new value. Omit to get current value.
  2139. */
  2140. value?: string | boolean | number;
  2141. }
  2142. export interface EnterWorktreeInput {
  2143. /**
  2144. * Optional name for the 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.
  2145. */
  2146. name?: string;
  2147. }
  2148. export interface ExitWorktreeInput {
  2149. /**
  2150. * "keep" leaves the worktree and branch on disk; "remove" deletes both.
  2151. */
  2152. action: "keep" | "remove";
  2153. /**
  2154. * Required true when action is "remove" and the worktree has uncommitted files or unmerged commits. The tool will refuse and list them otherwise.
  2155. */
  2156. discard_changes?: boolean;
  2157. }
  2158. export interface BashOutput {
  2159. /**
  2160. * The standard output of the command
  2161. */
  2162. stdout: string;
  2163. /**
  2164. * The standard error output of the command
  2165. */
  2166. stderr: string;
  2167. /**
  2168. * Path to raw output file for large MCP tool outputs
  2169. */
  2170. rawOutputPath?: string;
  2171. /**
  2172. * Whether the command was interrupted
  2173. */
  2174. interrupted: boolean;
  2175. /**
  2176. * Flag to indicate if stdout contains image data
  2177. */
  2178. isImage?: boolean;
  2179. /**
  2180. * ID of the background task if command is running in background
  2181. */
  2182. backgroundTaskId?: string;
  2183. /**
  2184. * True if the user manually backgrounded the command with Ctrl+B
  2185. */
  2186. backgroundedByUser?: boolean;
  2187. /**
  2188. * True if assistant-mode auto-backgrounded a long-running blocking command
  2189. */
  2190. assistantAutoBackgrounded?: boolean;
  2191. /**
  2192. * Flag to indicate if sandbox mode was overridden
  2193. */
  2194. dangerouslyDisableSandbox?: boolean;
  2195. /**
  2196. * Semantic interpretation for non-error exit codes with special meaning
  2197. */
  2198. returnCodeInterpretation?: string;
  2199. /**
  2200. * Whether the command is expected to produce no output on success
  2201. */
  2202. noOutputExpected?: boolean;
  2203. /**
  2204. * Structured content blocks
  2205. */
  2206. structuredContent?: unknown[];
  2207. /**
  2208. * Path to the persisted full output in tool-results dir (set when output is too large for inline)
  2209. */
  2210. persistedOutputPath?: string;
  2211. /**
  2212. * Total size of the output in bytes (set when output is too large for inline)
  2213. */
  2214. persistedOutputSize?: number;
  2215. }
  2216. export interface ExitPlanModeOutput {
  2217. /**
  2218. * The plan that was presented to the user
  2219. */
  2220. plan: string | null;
  2221. isAgent: boolean;
  2222. /**
  2223. * The file path where the plan was saved
  2224. */
  2225. filePath?: string;
  2226. /**
  2227. * Whether the Agent tool is available in the current context
  2228. */
  2229. hasTaskTool?: boolean;
  2230. /**
  2231. * True when the user edited the plan (CCR web UI or Ctrl+G); determines whether the plan is echoed back in tool_result
  2232. */
  2233. planWasEdited?: boolean;
  2234. /**
  2235. * When true, the teammate has sent a plan approval request to the team leader
  2236. */
  2237. awaitingLeaderApproval?: boolean;
  2238. /**
  2239. * Unique identifier for the plan approval request
  2240. */
  2241. requestId?: string;
  2242. }
  2243. export interface FileEditOutput {
  2244. /**
  2245. * The file path that was edited
  2246. */
  2247. filePath: string;
  2248. /**
  2249. * The original string that was replaced
  2250. */
  2251. oldString: string;
  2252. /**
  2253. * The new string that replaced it
  2254. */
  2255. newString: string;
  2256. /**
  2257. * The original file contents before editing
  2258. */
  2259. originalFile: string;
  2260. /**
  2261. * Diff patch showing the changes
  2262. */
  2263. structuredPatch: {
  2264. oldStart: number;
  2265. oldLines: number;
  2266. newStart: number;
  2267. newLines: number;
  2268. lines: string[];
  2269. }[];
  2270. /**
  2271. * Whether the user modified the proposed changes
  2272. */
  2273. userModified: boolean;
  2274. /**
  2275. * Whether all occurrences were replaced
  2276. */
  2277. replaceAll: boolean;
  2278. gitDiff?: {
  2279. filename: string;
  2280. status: "modified" | "added";
  2281. additions: number;
  2282. deletions: number;
  2283. changes: number;
  2284. patch: string;
  2285. /**
  2286. * GitHub owner/repo when available
  2287. */
  2288. repository?: string | null;
  2289. };
  2290. }
  2291. export interface FileWriteOutput {
  2292. /**
  2293. * Whether a new file was created or an existing file was updated
  2294. */
  2295. type: "create" | "update";
  2296. /**
  2297. * The path to the file that was written
  2298. */
  2299. filePath: string;
  2300. /**
  2301. * The content that was written to the file
  2302. */
  2303. content: string;
  2304. /**
  2305. * Diff patch showing the changes
  2306. */
  2307. structuredPatch: {
  2308. oldStart: number;
  2309. oldLines: number;
  2310. newStart: number;
  2311. newLines: number;
  2312. lines: string[];
  2313. }[];
  2314. /**
  2315. * The original file content before the write (null for new files)
  2316. */
  2317. originalFile: string | null;
  2318. gitDiff?: {
  2319. filename: string;
  2320. status: "modified" | "added";
  2321. additions: number;
  2322. deletions: number;
  2323. changes: number;
  2324. patch: string;
  2325. /**
  2326. * GitHub owner/repo when available
  2327. */
  2328. repository?: string | null;
  2329. };
  2330. }
  2331. export interface GlobOutput {
  2332. /**
  2333. * Time taken to execute the search in milliseconds
  2334. */
  2335. durationMs: number;
  2336. /**
  2337. * Total number of files found
  2338. */
  2339. numFiles: number;
  2340. /**
  2341. * Array of file paths that match the pattern
  2342. */
  2343. filenames: string[];
  2344. /**
  2345. * Whether results were truncated (limited to 100 files)
  2346. */
  2347. truncated: boolean;
  2348. }
  2349. export interface GrepOutput {
  2350. mode?: "content" | "files_with_matches" | "count";
  2351. numFiles: number;
  2352. filenames: string[];
  2353. content?: string;
  2354. numLines?: number;
  2355. numMatches?: number;
  2356. appliedLimit?: number;
  2357. appliedOffset?: number;
  2358. }
  2359. export interface TaskStopOutput {
  2360. /**
  2361. * Status message about the operation
  2362. */
  2363. message: string;
  2364. /**
  2365. * The ID of the task that was stopped
  2366. */
  2367. task_id: string;
  2368. /**
  2369. * The type of the task that was stopped
  2370. */
  2371. task_type: string;
  2372. /**
  2373. * The command or description of the stopped task
  2374. */
  2375. command?: string;
  2376. }
  2377. export interface NotebookEditOutput {
  2378. /**
  2379. * The new source code that was written to the cell
  2380. */
  2381. new_source: string;
  2382. /**
  2383. * The ID of the cell that was edited
  2384. */
  2385. cell_id?: string;
  2386. /**
  2387. * The type of the cell
  2388. */
  2389. cell_type: "code" | "markdown";
  2390. /**
  2391. * The programming language of the notebook
  2392. */
  2393. language: string;
  2394. /**
  2395. * The edit mode that was used
  2396. */
  2397. edit_mode: string;
  2398. /**
  2399. * Error message if the operation failed
  2400. */
  2401. error?: string;
  2402. /**
  2403. * The path to the notebook file
  2404. */
  2405. notebook_path: string;
  2406. /**
  2407. * The original notebook content before modification
  2408. */
  2409. original_file: string;
  2410. /**
  2411. * The updated notebook content after modification
  2412. */
  2413. updated_file: string;
  2414. }
  2415. export interface ReadMcpResourceOutput {
  2416. contents: {
  2417. /**
  2418. * Resource URI
  2419. */
  2420. uri: string;
  2421. /**
  2422. * MIME type of the content
  2423. */
  2424. mimeType?: string;
  2425. /**
  2426. * Text content of the resource
  2427. */
  2428. text?: string;
  2429. /**
  2430. * Path where binary blob content was saved
  2431. */
  2432. blobSavedTo?: string;
  2433. }[];
  2434. }
  2435. export interface TodoWriteOutput {
  2436. /**
  2437. * The todo list before the update
  2438. */
  2439. oldTodos: {
  2440. content: string;
  2441. status: "pending" | "in_progress" | "completed";
  2442. activeForm: string;
  2443. }[];
  2444. /**
  2445. * The todo list after the update
  2446. */
  2447. newTodos: {
  2448. content: string;
  2449. status: "pending" | "in_progress" | "completed";
  2450. activeForm: string;
  2451. }[];
  2452. verificationNudgeNeeded?: boolean;
  2453. }
  2454. export interface WebFetchOutput {
  2455. /**
  2456. * Size of the fetched content in bytes
  2457. */
  2458. bytes: number;
  2459. /**
  2460. * HTTP response code
  2461. */
  2462. code: number;
  2463. /**
  2464. * HTTP response code text
  2465. */
  2466. codeText: string;
  2467. /**
  2468. * Processed result from applying the prompt to the content
  2469. */
  2470. result: string;
  2471. /**
  2472. * Time taken to fetch and process the content
  2473. */
  2474. durationMs: number;
  2475. /**
  2476. * The URL that was fetched
  2477. */
  2478. url: string;
  2479. }
  2480. export interface WebSearchOutput {
  2481. /**
  2482. * The search query that was executed
  2483. */
  2484. query: string;
  2485. /**
  2486. * Search results and/or text commentary from the model
  2487. */
  2488. results: (
  2489. | {
  2490. /**
  2491. * ID of the tool use
  2492. */
  2493. tool_use_id: string;
  2494. /**
  2495. * Array of search hits
  2496. */
  2497. content: {
  2498. /**
  2499. * The title of the search result
  2500. */
  2501. title: string;
  2502. /**
  2503. * The URL of the search result
  2504. */
  2505. url: string;
  2506. }[];
  2507. }
  2508. | string
  2509. )[];
  2510. /**
  2511. * Time taken to complete the search operation
  2512. */
  2513. durationSeconds: number;
  2514. }
  2515. export interface AskUserQuestionOutput {
  2516. /**
  2517. * The questions that were asked
  2518. */
  2519. questions: {
  2520. /**
  2521. * 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?"
  2522. */
  2523. question: string;
  2524. /**
  2525. * Very short label displayed as a chip/tag (max 12 chars). Examples: "Auth method", "Library", "Approach".
  2526. */
  2527. header: string;
  2528. /**
  2529. * 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.
  2530. *
  2531. * @minItems 2
  2532. * @maxItems 4
  2533. */
  2534. options:
  2535. | [
  2536. {
  2537. /**
  2538. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  2539. */
  2540. label: string;
  2541. /**
  2542. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  2543. */
  2544. description: string;
  2545. /**
  2546. * 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.
  2547. */
  2548. preview?: string;
  2549. },
  2550. {
  2551. /**
  2552. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  2553. */
  2554. label: string;
  2555. /**
  2556. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  2557. */
  2558. description: string;
  2559. /**
  2560. * 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.
  2561. */
  2562. preview?: string;
  2563. }
  2564. ]
  2565. | [
  2566. {
  2567. /**
  2568. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  2569. */
  2570. label: string;
  2571. /**
  2572. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  2573. */
  2574. description: string;
  2575. /**
  2576. * 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.
  2577. */
  2578. preview?: string;
  2579. },
  2580. {
  2581. /**
  2582. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  2583. */
  2584. label: string;
  2585. /**
  2586. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  2587. */
  2588. description: string;
  2589. /**
  2590. * 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.
  2591. */
  2592. preview?: string;
  2593. },
  2594. {
  2595. /**
  2596. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  2597. */
  2598. label: string;
  2599. /**
  2600. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  2601. */
  2602. description: string;
  2603. /**
  2604. * 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.
  2605. */
  2606. preview?: string;
  2607. }
  2608. ]
  2609. | [
  2610. {
  2611. /**
  2612. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  2613. */
  2614. label: string;
  2615. /**
  2616. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  2617. */
  2618. description: string;
  2619. /**
  2620. * 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.
  2621. */
  2622. preview?: string;
  2623. },
  2624. {
  2625. /**
  2626. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  2627. */
  2628. label: string;
  2629. /**
  2630. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  2631. */
  2632. description: string;
  2633. /**
  2634. * 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.
  2635. */
  2636. preview?: string;
  2637. },
  2638. {
  2639. /**
  2640. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  2641. */
  2642. label: string;
  2643. /**
  2644. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  2645. */
  2646. description: string;
  2647. /**
  2648. * 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.
  2649. */
  2650. preview?: string;
  2651. },
  2652. {
  2653. /**
  2654. * The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
  2655. */
  2656. label: string;
  2657. /**
  2658. * Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
  2659. */
  2660. description: string;
  2661. /**
  2662. * 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.
  2663. */
  2664. preview?: string;
  2665. }
  2666. ];
  2667. /**
  2668. * Set to true to allow the user to select multiple options instead of just one. Use when choices are not mutually exclusive.
  2669. */
  2670. multiSelect: boolean;
  2671. }[];
  2672. /**
  2673. * The answers provided by the user (question text -> answer string; multi-select answers are comma-separated)
  2674. */
  2675. answers: {
  2676. [k: string]: string;
  2677. };
  2678. /**
  2679. * Optional per-question annotations from the user (e.g., notes on preview selections). Keyed by question text.
  2680. */
  2681. annotations?: {
  2682. [k: string]: {
  2683. /**
  2684. * The preview content of the selected option, if the question used previews.
  2685. */
  2686. preview?: string;
  2687. /**
  2688. * Free-text notes the user added to their selection.
  2689. */
  2690. notes?: string;
  2691. };
  2692. };
  2693. }
  2694. export interface ConfigOutput {
  2695. success: boolean;
  2696. operation?: "get" | "set";
  2697. setting?: string;
  2698. value?: unknown;
  2699. previousValue?: unknown;
  2700. newValue?: unknown;
  2701. error?: string;
  2702. }
  2703. export interface EnterWorktreeOutput {
  2704. worktreePath: string;
  2705. worktreeBranch?: string;
  2706. message: string;
  2707. }
  2708. export interface ExitWorktreeOutput {
  2709. action: "keep" | "remove";
  2710. originalCwd: string;
  2711. worktreePath: string;
  2712. worktreeBranch?: string;
  2713. tmuxSessionName?: string;
  2714. discardedFiles?: number;
  2715. discardedCommits?: number;
  2716. message: string;
  2717. }