RunbookAsToolOptions
Interface: RunbookAsToolOptions
Defined in: src/core/runbook/types.ts:170
Everything runbookAsTool accepts. Smallest legal call:
{ name, description, procedure } — and it still yields the spine.
Properties
argumentsFrom?
readonlyoptionalargumentsFrom?: readonlystring[]
Defined in: src/core/runbook/types.ts:186
composedOf?
readonlyoptionalcomposedOf?: readonlystring[]
Defined in: src/core/runbook/types.ts:189
The named ingredient tools the procedure calls through ctx.tools —
drift-checked at agent build.
description
readonlydescription:string
Defined in: src/core/runbook/types.ts:174
REQUIRED — a description-less tool is invisible to the model.
inputSchema?
readonlyoptionalinputSchema?:Readonly<Record<string,unknown>>
Defined in: src/core/runbook/types.ts:194
Explicit input schema wins; otherwise the chart's .contract() input
is lifted when it is a plain JSON-Schema object (a parseable schema —
zod et al. — cannot be serialized for the model and falls back to the
empty-object default).
keepRecord?
readonlyoptionalkeepRecord?:boolean
Defined in: src/core/runbook/types.ts:213
Keep each invocation's inner record for inspect_tool_run descent.
keepRecordLimit?
readonlyoptionalkeepRecordLimit?:number
Defined in: src/core/runbook/types.ts:215
Bounded LRU size for kept records (requires keepRecord: true).
name
readonlyname:string
Defined in: src/core/runbook/types.ts:172
Tool name the LLM dispatches by.
owner?
readonlyoptionalowner?:ToolOwner
Defined in: src/core/runbook/types.ts:183
presentation?
readonlyoptionalpresentation?:RunbookPresentation
Defined in: src/core/runbook/types.ts:205
Who renders the rowset — see RunbookPresentation. Default
'prose'; an unknown value is refused at definition, never read as the
default (a mis-spelled dial that silently keeps working is a dial that
cannot be trusted to have been set).
procedure
readonlyprocedure:RunbookProcedure
Defined in: src/core/runbook/types.ts:176
The procedure factory — see RunbookProcedure.
recorders?
readonlyoptionalrecorders?: readonlyCombinedRecorder[]
Defined in: src/core/runbook/types.ts:211
Observers attached to each invocation's fresh inner executor.
redact?
readonlyoptionalredact?:RedactionPolicy
Defined in: src/core/runbook/types.ts:233
Redaction policy for the inner run. One rule for everything the tool
shows (9.89.1): the commit log is scrubbed at write time — and since
footprintjs 9.19.0 (the floor from 9.89.2) so is every path that used to
bypass it: a subflow's seed and merge-back, tracked reads, dot-path
fields, the narrated Input: line — and the envelope's state, the
walk's recording and the kept record are all served from footprintjs's
redacted view through servableSnapshot, exactly as the substrate
serves it. The last limit that view had — a subflow's own heap, which
servableSnapshot refolded from its scrubbed history — is closed by
footprintjs 9.20.0 (the floor from 9.89.3): nothing left the log
carries that the served view does not scrub; the checkpoint is not a
served view. See FlowchartAsToolOptions.redact for the two things it
does not govern: the run's fold base and the resume checkpoint.
Joined with the policy the calling run is covered by (ctx.redact — the
agent's own redact): the procedure runs nested in that run, and a run's
policy covers the runs nested in it. Either alone keeps a name out.
resultCeiling?
readonlyoptionalresultCeiling?:ToolResultCeiling
Defined in: src/core/runbook/types.ts:184
resultClass?
readonlyoptionalresultClass?:ToolResultClass
Defined in: src/core/runbook/types.ts:182
resultKind?
readonlyoptionalresultKind?:string
Defined in: src/core/runbook/types.ts:181
Selects the envelope projection ('verdict/*' gets the rowset) AND is
the artifact kind a placed result is minted under.
rules?
readonlyoptionalrules?:RunbookRules
Defined in: src/core/runbook/types.ts:198
Rule provenance — see RunbookRules.
verdicts?
readonlyoptionalverdicts?:RunbookVerdictsOptions
Defined in: src/core/runbook/types.ts:200
The verdict projection's dials — see RunbookVerdictsOptions.
walk?
readonlyoptionalwalk?:RunbookWalkOptions
Defined in: src/core/runbook/types.ts:207
The walk policy — see RunbookWalkOptions.
wants?
readonlyoptionalwants?:Readonly<Record<string,string>>
Defined in: src/core/runbook/types.ts:185
