rulvar API reference

---

rulvar API reference / @rulvar/plan / PlanToolRuntime

Interface: PlanToolRuntime

Defined in: packages/plan/src/tools.ts:338

The engine seam the plan tools close over.

Methods

kbPropose()?

optional kbPropose(input): Promise<{
  entryRef: number;
}>;

Defined in: packages/plan/src/tools.ts:348

Phase 3 opt-in: resolves the tier-relative payload into a concrete KbProposal and journals it as the observation_add ledger.op. Absent unless the run opted into kb_propose.

Parameters

Parameter	Type
input	KbProposeInput

Returns

Promise<{ entryRef: number; }>

---

ledgerAppend()

ledgerAppend(op): Promise<{
  entryRef: number;
}>;

Defined in: packages/plan/src/tools.ts:341

Parameters

Parameter	Type
op	LedgerOp

Returns

Promise<{ entryRef: number; }>

---

ledgerRead()

ledgerRead(): LedgerView;

Defined in: packages/plan/src/tools.ts:342

Returns

LedgerView

---

planRevise()

planRevise(request): Promise<PlanReviseResult>;

Defined in: packages/plan/src/tools.ts:340

Parameters

Parameter	Type
request	PlanReviseRequest

Returns

Promise&lt;PlanReviseResult&gt;

---

planView()

planView(): PlanViewRender;

Defined in: packages/plan/src/tools.ts:339

Returns

PlanViewRender