Skip to content

Interface: ToolEffect ​

Defined in: ports/tool-effect.ts:8

Domain-agnostic effect descriptor emitted pre-flight by ToolDriver.describeEffects() or synthesized post-flight by CheckpointableScope.diffEffects().

Keyed on mutatesScope by ScopeLockManager to coordinate shared-read vs exclusive-write locks and evaluated by PolicyGuardASTNode, QuotaTripwireASTNode, and TelemetryCollectorASTNode.

Extended by ​

Properties ​

PropertyModifierTypeDescriptionDefined in
attributes?readonlyReadonly<Record<string, unknown>>Domain-specific structured effect attributes (such as paths, mode, or amountUsd).ports/tool-effect.ts:14
kindreadonlystringDomain-qualified effect kind identifier (such as 'fs:effect' or 'billing:effect').ports/tool-effect.ts:10
mutatesScope?readonlybooleanWhether the effect mutates the active isolation scope state (true acquires an exclusive write lock).ports/tool-effect.ts:12

Released under the MIT License.