Type Alias ToolConfig

Per-tool configuration for built-in tools. Allows SDK consumers to customize tool behavior that the CLI hardcodes.

type ToolConfig = {
askUserQuestion?: { previewFormat?: "markdown" | "html" };
}

Index

Claude SDK

askUserQuestion?

Claude SDK

`Optional`askUserQuestion

askUserQuestion?: { previewFormat?: "markdown" | "html" }

Type Declaration

OptionalpreviewFormat?: "markdown" | "html"
Content format for the preview field on question options. Controls what the model is instructed to emit and how the field is described in the tool schema.
- 'markdown' — Markdown/ASCII content (CLI default, rendered in a monospace box)
- 'html' — Self-contained HTML fragments (for web-based SDK consumers)
Default
```
'markdown'
```