Back to docs

Tool Ask User

Category: Interaction · Tier: All

Create a structured prompt to ask the user a question. Returns AskUserQuestion-compatible format. Use this when you need user input before proceeding. Claude should present this to the user and return their selection.

When to Use

The ask_user tool enables structured prompts for user input during tool-driven workflows.

Parameters

Parameter Type Required Description
question string Yes The complete question to ask the user
header string Yes Short label displayed as chip/tag (max 12 chars)
context array No Contextual information to help the user decide
options array Yes Available choices (2-4 options, 'Other' auto-added by SDK)
multiSelect boolean No Whether multiple options can be selected
securityNote string No Optional security/privacy note

Example

Ask the user which test environment to use

Tips

  • Combine with other tools for comprehensive analysis

Related

From the Blog