@anthropic-ai/claude-code
Version:
Use Claude, Anthropic's AI assistant, right from your terminal. Claude can understand your codebase, edit files, run terminal commands, and handle entire workflows for you.
1,214 lines (1,211 loc) • 117 kB
TypeScript
/* eslint-disable */
/**
* This file was automatically generated by json-schema-to-typescript.
* DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
* and run json-schema-to-typescript to regenerate this file.
*/
/**
* JSON Schema definitions for Claude CLI tool inputs
*/
export type ToolInputSchemas =
| AgentInput
| BashInput
| TaskOutputInput
| ExitPlanModeInput
| FileEditInput
| FileReadInput
| FileWriteInput
| GlobInput
| GrepInput
| TaskStopInput
| ListMcpResourcesInput
| McpInput
| NotebookEditInput
| ReadMcpResourceInput
| TodoWriteInput
| WebFetchInput
| WebSearchInput
| AskUserQuestionInput
| ConfigInput
| EnterWorktreeInput
| ExitWorktreeInput
| ToolOutputSchemas;
export type ToolOutputSchemas =
| AgentOutput
| BashOutput
| ExitPlanModeOutput
| FileEditOutput
| FileReadOutput
| FileWriteOutput
| GlobOutput
| GrepOutput
| TaskStopOutput
| ListMcpResourcesOutput
| McpOutput
| NotebookEditOutput
| ReadMcpResourceOutput
| TodoWriteOutput
| WebFetchOutput
| WebSearchOutput
| AskUserQuestionOutput
| ConfigOutput
| EnterWorktreeOutput
| ExitWorktreeOutput;
export type AgentOutput =
| {
agentId: string;
agentType?: string;
content: {
type: "text";
text: string;
}[];
totalToolUseCount: number;
totalDurationMs: number;
totalTokens: number;
usage: {
input_tokens: number;
output_tokens: number;
cache_creation_input_tokens: number | null;
cache_read_input_tokens: number | null;
server_tool_use: {
web_search_requests: number;
web_fetch_requests: number;
} | null;
service_tier: ("standard" | "priority" | "batch") | null;
cache_creation: {
ephemeral_1h_input_tokens: number;
ephemeral_5m_input_tokens: number;
} | null;
};
status: "completed";
prompt: string;
}
| {
status: "async_launched";
/**
* The ID of the async agent
*/
agentId: string;
/**
* The description of the task
*/
description: string;
/**
* The prompt for the agent
*/
prompt: string;
/**
* Path to the output file for checking agent progress
*/
outputFile: string;
/**
* Whether the calling agent has Read/Bash tools to check progress
*/
canReadOutputFile?: boolean;
};
export type FileReadOutput =
| {
type: "text";
file: {
/**
* The path to the file that was read
*/
filePath: string;
/**
* The content of the file
*/
content: string;
/**
* Number of lines in the returned content
*/
numLines: number;
/**
* The starting line number
*/
startLine: number;
/**
* Total number of lines in the file
*/
totalLines: number;
};
}
| {
type: "image";
file: {
/**
* Base64-encoded image data
*/
base64: string;
/**
* The MIME type of the image
*/
type: "image/jpeg" | "image/png" | "image/gif" | "image/webp";
/**
* Original file size in bytes
*/
originalSize: number;
/**
* Image dimension info for coordinate mapping
*/
dimensions?: {
/**
* Original image width in pixels
*/
originalWidth?: number;
/**
* Original image height in pixels
*/
originalHeight?: number;
/**
* Displayed image width in pixels (after resizing)
*/
displayWidth?: number;
/**
* Displayed image height in pixels (after resizing)
*/
displayHeight?: number;
};
};
}
| {
type: "notebook";
file: {
/**
* The path to the notebook file
*/
filePath: string;
/**
* Array of notebook cells
*/
cells: unknown[];
};
}
| {
type: "pdf";
file: {
/**
* The path to the PDF file
*/
filePath: string;
/**
* Base64-encoded PDF data
*/
base64: string;
/**
* Original file size in bytes
*/
originalSize: number;
};
}
| {
type: "parts";
file: {
/**
* The path to the PDF file
*/
filePath: string;
/**
* Original file size in bytes
*/
originalSize: number;
/**
* Number of pages extracted
*/
count: number;
/**
* Directory containing extracted page images
*/
outputDir: string;
};
}
| {
type: "file_unchanged";
file: {
/**
* The path to the file
*/
filePath: string;
};
};
export type ListMcpResourcesOutput = {
/**
* Resource URI
*/
uri: string;
/**
* Resource name
*/
name: string;
/**
* MIME type of the resource
*/
mimeType?: string;
/**
* Resource description
*/
description?: string;
/**
* Server that provides this resource
*/
server: string;
}[];
/**
* MCP tool execution result
*/
export type McpOutput = string;
export interface AgentInput {
/**
* A short (3-5 word) description of the task
*/
description: string;
/**
* The task for the agent to perform
*/
prompt: string;
/**
* The type of specialized agent to use for this task
*/
subagent_type?: string;
/**
* Optional model override for this agent. Takes precedence over the agent definition's model frontmatter. If omitted, uses the agent definition's model, or inherits from the parent.
*/
model?: "sonnet" | "opus" | "haiku";
/**
* Set to true to run this agent in the background. You will be notified when it completes.
*/
run_in_background?: boolean;
/**
* Name for the spawned agent. Makes it addressable via SendMessage({to: name}) while running.
*/
name?: string;
/**
* Team name for spawning. Uses current team context if omitted.
*/
team_name?: string;
/**
* Permission mode for spawned teammate (e.g., "plan" to require plan approval).
*/
mode?: "acceptEdits" | "bypassPermissions" | "default" | "dontAsk" | "plan";
/**
* Isolation mode. "worktree" creates a temporary git worktree so the agent works on an isolated copy of the repo.
*/
isolation?: "worktree";
}
export interface BashInput {
/**
* The command to execute
*/
command: string;
/**
* Optional timeout in milliseconds (max 600000)
*/
timeout?: number;
/**
* Clear, concise description of what this command does in active voice. Never use words like "complex" or "risk" in the description - just describe what it does.
*
* For simple commands (git, npm, standard CLI tools), keep it brief (5-10 words):
* - ls → "List files in current directory"
* - git status → "Show working tree status"
* - npm install → "Install package dependencies"
*
* For commands that are harder to parse at a glance (piped commands, obscure flags, etc.), add enough context to clarify what it does:
* - find . -name "*.tmp" -exec rm {} \; → "Find and delete all .tmp files recursively"
* - git reset --hard origin/main → "Discard all local changes and match remote main"
* - curl -s url | jq '.data[]' → "Fetch JSON from URL and extract data array elements"
*/
description?: string;
/**
* Set to true to run this command in the background. Use Read to read the output later.
*/
run_in_background?: boolean;
/**
* Set this to true to dangerously override sandbox mode and run commands without sandboxing.
*/
dangerouslyDisableSandbox?: boolean;
}
export interface TaskOutputInput {
/**
* The task ID to get output from
*/
task_id: string;
/**
* Whether to wait for completion
*/
block: boolean;
/**
* Max wait time in ms
*/
timeout: number;
}
export interface ExitPlanModeInput {
/**
* Prompt-based permissions needed to implement the plan. These describe categories of actions rather than specific commands.
*/
allowedPrompts?: {
/**
* The tool this prompt applies to
*/
tool: "Bash";
/**
* Semantic description of the action, e.g. "run tests", "install dependencies"
*/
prompt: string;
}[];
[k: string]: unknown;
}
export interface FileEditInput {
/**
* The absolute path to the file to modify
*/
file_path: string;
/**
* The text to replace
*/
old_string: string;
/**
* The text to replace it with (must be different from old_string)
*/
new_string: string;
/**
* Replace all occurrences of old_string (default false)
*/
replace_all?: boolean;
}
export interface FileReadInput {
/**
* The absolute path to the file to read
*/
file_path: string;
/**
* The line number to start reading from. Only provide if the file is too large to read at once
*/
offset?: number;
/**
* The number of lines to read. Only provide if the file is too large to read at once.
*/
limit?: number;
/**
* Page range for PDF files (e.g., "1-5", "3", "10-20"). Only applicable to PDF files. Maximum 20 pages per request.
*/
pages?: string;
}
export interface FileWriteInput {
/**
* The absolute path to the file to write (must be absolute, not relative)
*/
file_path: string;
/**
* The content to write to the file
*/
content: string;
}
export interface GlobInput {
/**
* The glob pattern to match files against
*/
pattern: string;
/**
* The directory to search in. If not specified, the current working directory will be used. IMPORTANT: Omit this field to use the default directory. DO NOT enter "undefined" or "null" - simply omit it for the default behavior. Must be a valid directory path if provided.
*/
path?: string;
}
export interface GrepInput {
/**
* The regular expression pattern to search for in file contents
*/
pattern: string;
/**
* File or directory to search in (rg PATH). Defaults to current working directory.
*/
path?: string;
/**
* Glob pattern to filter files (e.g. "*.js", "*.{ts,tsx}") - maps to rg --glob
*/
glob?: string;
/**
* Output mode: "content" shows matching lines (supports -A/-B/-C context, -n line numbers, head_limit), "files_with_matches" shows file paths (supports head_limit), "count" shows match counts (supports head_limit). Defaults to "files_with_matches".
*/
output_mode?: "content" | "files_with_matches" | "count";
/**
* Number of lines to show before each match (rg -B). Requires output_mode: "content", ignored otherwise.
*/
"-B"?: number;
/**
* Number of lines to show after each match (rg -A). Requires output_mode: "content", ignored otherwise.
*/
"-A"?: number;
/**
* Alias for context.
*/
"-C"?: number;
/**
* Number of lines to show before and after each match (rg -C). Requires output_mode: "content", ignored otherwise.
*/
context?: number;
/**
* Show line numbers in output (rg -n). Requires output_mode: "content", ignored otherwise. Defaults to true.
*/
"-n"?: boolean;
/**
* Case insensitive search (rg -i)
*/
"-i"?: boolean;
/**
* File type to search (rg --type). Common types: js, py, rust, go, java, etc. More efficient than include for standard file types.
*/
type?: string;
/**
* Limit output to first N lines/entries, equivalent to "| head -N". Works across all output modes: content (limits output lines), files_with_matches (limits file paths), count (limits count entries). Defaults to 250 when unspecified. Pass 0 for unlimited (use sparingly — large result sets waste context).
*/
head_limit?: number;
/**
* Skip first N lines/entries before applying head_limit, equivalent to "| tail -n +N | head -N". Works across all output modes. Defaults to 0.
*/
offset?: number;
/**
* Enable multiline mode where . matches newlines and patterns can span lines (rg -U --multiline-dotall). Default: false.
*/
multiline?: boolean;
}
export interface TaskStopInput {
/**
* The ID of the background task to stop
*/
task_id?: string;
/**
* Deprecated: use task_id instead
*/
shell_id?: string;
}
export interface ListMcpResourcesInput {
/**
* Optional server name to filter resources by
*/
server?: string;
}
export interface McpInput {
[k: string]: unknown;
}
export interface NotebookEditInput {
/**
* The absolute path to the Jupyter notebook file to edit (must be absolute, not relative)
*/
notebook_path: string;
/**
* The ID of the cell to edit. When inserting a new cell, the new cell will be inserted after the cell with this ID, or at the beginning if not specified.
*/
cell_id?: string;
/**
* The new source for the cell
*/
new_source: string;
/**
* The type of the cell (code or markdown). If not specified, it defaults to the current cell type. If using edit_mode=insert, this is required.
*/
cell_type?: "code" | "markdown";
/**
* The type of edit to make (replace, insert, delete). Defaults to replace.
*/
edit_mode?: "replace" | "insert" | "delete";
}
export interface ReadMcpResourceInput {
/**
* The MCP server name
*/
server: string;
/**
* The resource URI to read
*/
uri: string;
}
export interface TodoWriteInput {
/**
* The updated todo list
*/
todos: {
content: string;
status: "pending" | "in_progress" | "completed";
activeForm: string;
}[];
}
export interface WebFetchInput {
/**
* The URL to fetch content from
*/
url: string;
/**
* The prompt to run on the fetched content
*/
prompt: string;
}
export interface WebSearchInput {
/**
* The search query to use
*/
query: string;
/**
* Only include search results from these domains
*/
allowed_domains?: string[];
/**
* Never include search results from these domains
*/
blocked_domains?: string[];
}
export interface AskUserQuestionInput {
/**
* Questions to ask the user (1-4 questions)
*
* @minItems 1
* @maxItems 4
*/
questions:
| [
{
/**
* The complete question to ask the user. Should be clear, specific, and end with a question mark. Example: "Which library should we use for date formatting?" If multiSelect is true, phrase it accordingly, e.g. "Which features do you want to enable?"
*/
question: string;
/**
* Very short label displayed as a chip/tag (max 12 chars). Examples: "Auth method", "Library", "Approach".
*/
header: string;
/**
* The available choices for this question. Must have 2-4 options. Each option should be a distinct, mutually exclusive choice (unless multiSelect is enabled). There should be no 'Other' option, that will be provided automatically.
*
* @minItems 2
* @maxItems 4
*/
options:
| [
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
},
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
}
]
| [
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
},
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
},
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
}
]
| [
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
},
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
},
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
},
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
}
];
/**
* Set to true to allow the user to select multiple options instead of just one. Use when choices are not mutually exclusive.
*/
multiSelect: boolean;
}
]
| [
{
/**
* The complete question to ask the user. Should be clear, specific, and end with a question mark. Example: "Which library should we use for date formatting?" If multiSelect is true, phrase it accordingly, e.g. "Which features do you want to enable?"
*/
question: string;
/**
* Very short label displayed as a chip/tag (max 12 chars). Examples: "Auth method", "Library", "Approach".
*/
header: string;
/**
* The available choices for this question. Must have 2-4 options. Each option should be a distinct, mutually exclusive choice (unless multiSelect is enabled). There should be no 'Other' option, that will be provided automatically.
*
* @minItems 2
* @maxItems 4
*/
options:
| [
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
},
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
}
]
| [
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
},
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
},
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
}
]
| [
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
},
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
},
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
},
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
}
];
/**
* Set to true to allow the user to select multiple options instead of just one. Use when choices are not mutually exclusive.
*/
multiSelect: boolean;
},
{
/**
* The complete question to ask the user. Should be clear, specific, and end with a question mark. Example: "Which library should we use for date formatting?" If multiSelect is true, phrase it accordingly, e.g. "Which features do you want to enable?"
*/
question: string;
/**
* Very short label displayed as a chip/tag (max 12 chars). Examples: "Auth method", "Library", "Approach".
*/
header: string;
/**
* The available choices for this question. Must have 2-4 options. Each option should be a distinct, mutually exclusive choice (unless multiSelect is enabled). There should be no 'Other' option, that will be provided automatically.
*
* @minItems 2
* @maxItems 4
*/
options:
| [
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
},
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
}
]
| [
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
},
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
},
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
}
]
| [
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
},
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
},
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
},
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
}
];
/**
* Set to true to allow the user to select multiple options instead of just one. Use when choices are not mutually exclusive.
*/
multiSelect: boolean;
}
]
| [
{
/**
* The complete question to ask the user. Should be clear, specific, and end with a question mark. Example: "Which library should we use for date formatting?" If multiSelect is true, phrase it accordingly, e.g. "Which features do you want to enable?"
*/
question: string;
/**
* Very short label displayed as a chip/tag (max 12 chars). Examples: "Auth method", "Library", "Approach".
*/
header: string;
/**
* The available choices for this question. Must have 2-4 options. Each option should be a distinct, mutually exclusive choice (unless multiSelect is enabled). There should be no 'Other' option, that will be provided automatically.
*
* @minItems 2
* @maxItems 4
*/
options:
| [
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
},
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
}
]
| [
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
},
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
},
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
}
]
| [
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
},
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
},
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
},
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
}
];
/**
* Set to true to allow the user to select multiple options instead of just one. Use when choices are not mutually exclusive.
*/
multiSelect: boolean;
},
{
/**
* The complete question to ask the user. Should be clear, specific, and end with a question mark. Example: "Which library should we use for date formatting?" If multiSelect is true, phrase it accordingly, e.g. "Which features do you want to enable?"
*/
question: string;
/**
* Very short label displayed as a chip/tag (max 12 chars). Examples: "Auth method", "Library", "Approach".
*/
header: string;
/**
* The available choices for this question. Must have 2-4 options. Each option should be a distinct, mutually exclusive choice (unless multiSelect is enabled). There should be no 'Other' option, that will be provided automatically.
*
* @minItems 2
* @maxItems 4
*/
options:
| [
{
/**
* The display text for this option that the user will see and select. Should be concise (1-5 words) and clearly describe the choice.
*/
label: string;
/**
* Explanation of what this option means or what will happen if chosen. Useful for providing context about trade-offs or implications.
*/
description: string;
/**
* Optional preview content rendered when this option is focused. Use for mockups, code snippets, or visual comparisons that help users compare options. See the tool description for the expected content format.
*/
preview?: string;
},
{