Toolmark

Appearance

toolmark-monorepo / @toolmark/tour / PlannerContext

Interface: PlannerContext ​

Defined in: packages/tour/src/types.ts:37

What a Planner receives.

Properties ​

goal ​

goal: string

Defined in: packages/tour/src/types.ts:39

What the user wants to achieve, as given to startTour.

mode ​

mode: TourMode

Defined in: packages/tour/src/types.ts:41

The mode the planned tour will run in.

signal ​

signal: AbortSignal

Defined in: packages/tour/src/types.ts:47

Aborted when the tour start is cancelled.

tools ​

tools: ToolManifestSummary[]

Defined in: packages/tour/src/types.ts:43

Summary manifest of the tools visible to caller tour.

Methods ​

describe() ​

describe(name): ToolManifest | undefined

Defined in: packages/tour/src/types.ts:45

Full manifest entry of one tool as visible to caller tour, or undefined.

Parameters ​

name ​

string

Returns ​

ToolManifest | undefined