Repository navigation
docs(reference): add AskUser tool reference - #83
Merged
Merged
Conversation
Document the AskUser questionnaire format, limits, output, availability, droid.ask_user JSON-RPC shapes, and the elicitation_dialog notification hook. Co-authored-by: factory-droid[bot] <138933559+factory-droid[bot]@users.noreply.github.com> Co-authored-by: factory-airamare01 <stomzy.mwendwa@factory.ai>
Contributor
Author
|
Droid finished @factory-droid[bot]'s task —— View job No candidate comments were submitted for validation. 0 inline comments posted |
factory-airamare01
approved these changes
Oct 23, 2026
factory-airamare01
left a comment
factory-airamare01
left a comment
Contributor
There was a problem hiding this comment.
Well covered. Ready for live consumption on docsite
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds an AskUser tool reference page (
/reference/ask-user-tool) so customers can parse the AskUser contract directly from our docs (requested by Adyen for use in their agent marketplace, Pylon #15245).The page is sourced from the current CLI implementation in
factory-mono(packages/droid-core/.../askUser.ts+schema.ts,packages/utils/src/askUser/parseQuestionnaire.ts,packages/droid-sdk-core/.../protocol/droid/schemas/cli.ts,apps/cli/.../ask-user.ts,AskUserAnswerStore.ts) and covers:questionnairestring, strict)[question],(multi),[topic],[option], plus the parser's tolerance rules (numbering/bullets, fences, headers, implicit questions, Yes/No default, topic normalization)[question]/[answer], comma-joined multi-select) and cancellation behavior (interrupts the turn)droid execoff; disabling viadisabledToolIdsdroid.ask_userrequest/response shapes for custom clientsNotificationhook withnotification_type: "elicitation_dialog"Also:
docs.jsondroid execJSON-RPC section and the hooks referenceNotificationsectionJP docs are left to the existing
sync-jp-docsworkflow.Validation
docs.jsonparses as valid JSONcc @factory-airamare01 (Stomzy Mwendwa), who requested this update.