Skip to main content

ModelTurnTool

@forge/monorepo

@forge/monorepo / backend/src / ModelTurnTool

Type Alias: ModelTurnTool

ModelTurnTool = object

Defined in: backend/src/models/streaming.ts:115

A tool the model may call this turn. execute is the platform's guarded execution path.

Properties​

category?​

readonly optional category?: string

Defined in: backend/src/models/streaming.ts:128

The tool's category, when the caller knows it — task #244.

Optional and never sent to the provider. It exists so a caller can express a policy about categories — AgentManifest.toolPolicy.categories names the ones that must stay resident when the catalogue is bounded — without the engine having to reach back into the registry for a descriptor it was already handed.

description?​

readonly optional description?: string

Defined in: backend/src/models/streaming.ts:117

inputSchema?​

readonly optional inputSchema?: unknown

Defined in: backend/src/models/streaming.ts:119

Zod schema or JSON-schema object; a permissive object schema is used when absent.

name​

readonly name: string

Defined in: backend/src/models/streaming.ts:116

Methods​

execute()​

execute(input, options?): Promise<unknown>

Defined in: backend/src/models/streaming.ts:120

Parameters​

input​

unknown

options?​

ModelToolCallOptions

Returns​

Promise<unknown>