Skip to content

Function: step()

ts
function step(label: string, run: (args: {
  label: string;
}) => 
  | ChatToolReturn
  | Promise<ChatToolReturn>): PlanStep;

Defined in: packages/sdk/src/renderer/templates/plan.ts:30

Build a PlanStep.

Parameters

ParameterTypeDescription
labelstringThe step text shown in its editable row.
run(args: { label: string; }) => | ChatToolReturn | Promise<ChatToolReturn>The action to run when the plan executes.

Returns

PlanStep

Matterway Assistant SDK Documentation