Toolmark

Appearance

toolmark-monorepo / @toolmark/core / StepwiseWizardOptions

Interface: StepwiseWizardOptions ​

Defined in: packages/core/src/wizard/wizard-tools.ts:116

Options for createStepwiseWizardTools (the stepwise fallback, spec §8.2).

Properties ​

currentAdapter ​

currentAdapter: () => FormAdapter<Record<string, unknown>> | undefined

Defined in: packages/core/src/wizard/wizard-tools.ts:124

The mounted form of the current step (<name>.step.fill writes through it).

Returns ​

FormAdapter<Record<string, unknown>> | undefined

currentStep ​

currentStep: () => object

Defined in: packages/core/src/wizard/wizard-tools.ts:126

The current step: its name and full schema (read on creation and by refresh()).

Returns ​

object

input ​

input: StandardSchemaV1

jsonSchema? ​

optional jsonSchema?: JsonSchema

name ​

name: string

description ​

description: string

Defined in: packages/core/src/wizard/wizard-tools.ts:120

LLM-facing description of the wizard.

name ​

name: string

Defined in: packages/core/src/wizard/wizard-tools.ts:118

Tool name prefix.

submitSummary? ​

optional submitSummary?: () => string

Defined in: packages/core/src/wizard/wizard-tools.ts:134

User-facing submit confirmation summary (default "Submit <title ?? name>").

Returns ​

string

title? ​

optional title?: string

Defined in: packages/core/src/wizard/wizard-tools.ts:122

User-facing title (used in the submit confirmation summary).

Methods ​

next() ​

next(): Promise<ToolResult<unknown>>

Defined in: packages/core/src/wizard/wizard-tools.ts:128

Validates the current step and moves forward; its result is returned to the agent.

Returns ​

Promise<ToolResult<unknown>>

previous() ​

previous(): void

Defined in: packages/core/src/wizard/wizard-tools.ts:130

Moves back one step.

Returns ​

void

submit() ​

submit(): Promise<ToolResult<unknown>>

Defined in: packages/core/src/wizard/wizard-tools.ts:132

Submits the wizard (<name>.submit, consequential).

Returns ​

Promise<ToolResult<unknown>>