Interface: RunbookAsToolOptions

Defined in: src/core/runbook/types.ts:169

Everything runbookAsTool accepts. Smallest legal call: { name, description, procedure } — and it still yields the spine.

Properties

argumentsFrom?

readonly optional argumentsFrom?: readonly string[]

Defined in: src/core/runbook/types.ts:185

---

composedOf?

readonly optional composedOf?: readonly string[]

Defined in: src/core/runbook/types.ts:188

The named ingredient tools the procedure calls through ctx.tools — drift-checked at agent build.

---

description

readonly description: string

Defined in: src/core/runbook/types.ts:173

REQUIRED — a description-less tool is invisible to the model.

---

inputSchema?

readonly optional inputSchema?: Readonly<Record<string, unknown>>

Defined in: src/core/runbook/types.ts:193

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?

readonly optional keepRecord?: boolean

Defined in: src/core/runbook/types.ts:212

Keep each invocation's inner record for inspect_tool_run descent.

---

keepRecordLimit?

readonly optional keepRecordLimit?: number

Defined in: src/core/runbook/types.ts:214

Bounded LRU size for kept records (requires keepRecord: true).

---

name

readonly name: string

Defined in: src/core/runbook/types.ts:171

Tool name the LLM dispatches by.

---

owner?

readonly optional owner?: ToolOwner

Defined in: src/core/runbook/types.ts:182

---

presentation?

readonly optional presentation?: RunbookPresentation

Defined in: src/core/runbook/types.ts:204

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

readonly procedure: RunbookProcedure

Defined in: src/core/runbook/types.ts:175

The procedure factory — see RunbookProcedure.

---

recorders?

readonly optional recorders?: readonly CombinedRecorder[]

Defined in: src/core/runbook/types.ts:210

Observers attached to each invocation's fresh inner executor.

---

redact?

readonly optional redact?: RedactionPolicy

Defined in: src/core/runbook/types.ts:216

Redaction policy for the inner run (commit-time scrub).

---

resultCeiling?

readonly optional resultCeiling?: ToolResultCeiling

Defined in: src/core/runbook/types.ts:183

---

resultClass?

readonly optional resultClass?: ToolResultClass

Defined in: src/core/runbook/types.ts:181

---

resultKind?

readonly optional resultKind?: string

Defined in: src/core/runbook/types.ts:180

Selects the envelope projection ('verdict/*' gets the rowset) AND is the artifact kind a placed result is minted under.

---

rules?

readonly optional rules?: RunbookRules

Defined in: src/core/runbook/types.ts:197

Rule provenance — see RunbookRules.

---

verdicts?

readonly optional verdicts?: RunbookVerdictsOptions

Defined in: src/core/runbook/types.ts:199

The verdict projection's dials — see RunbookVerdictsOptions.

---

walk?

readonly optional walk?: RunbookWalkOptions

Defined in: src/core/runbook/types.ts:206

The walk policy — see RunbookWalkOptions.

---

wants?

readonly optional wants?: Readonly<Record<string, string>>

Defined in: src/core/runbook/types.ts:184