Skip to content

BackgroundTasksConfig

Defined in: src/background-tasks/types.ts:6

Configures background tool execution.

readonly optional waitForCompletion?: boolean;

Defined in: src/background-tasks/types.ts:8

Wait for background work before an invocation returns. Defaults to true.


readonly optional agentic?: readonly (string | Tool)[];

Defined in: src/background-tasks/types.ts:10

Tools or registered tool names whose execution mode is selected by the model. Defaults to ['*'].


readonly optional always?: readonly (string | Tool)[];

Defined in: src/background-tasks/types.ts:12

Tools or registered tool names that always execute in the background.


readonly optional never?: readonly (string | Tool)[];

Defined in: src/background-tasks/types.ts:14

Tools or registered tool names that never execute in the background.


readonly optional maxConcurrency?: number;

Defined in: src/background-tasks/types.ts:16

Maximum number of physically executing background tasks. Defaults to 4.


readonly optional timeout?: number;

Defined in: src/background-tasks/types.ts:18

Per-execution timeout in milliseconds. Defaults to Infinity.