Skip to content

Ask User Question (ask_user_question)

Asks the user one or more structured questions during execution. Useful for gathering preferences, clarifying requirements, or getting decisions on implementation choices.

Parameters

ParameterRequiredDescription
questionsYesArray of question objects (max 4 questions)

Each question object:

FieldRequiredDescription
questionYesThe full question text, ending with ?
headerNoShort label displayed as a chip/tag (max 30 chars)
optionsYesArray of 2–4 answer choices
multiSelectNoAllow multiple answers (default: false)

Each option:

FieldRequiredDescription
labelYesDisplay text for the choice (1–5 words)
descriptionNoExplanation of what this option means

Usage notes

  • Users can always select "Other" to provide custom text input.
  • If you recommend a specific option, make it the first in the list and add "(Recommended)" at the end of the label.
  • The questions parameter is a real array — do NOT JSON-encode it as a string.

See Also

Released under the Apache-2.0 License.