Skip to Content

Interface ToolParameters

A JSON Schema object describing one tool's arguments.

Plain data, handed to a framework unchanged: Toolset.toAnthropic puts it under input_schema, Toolset.toOpenAI under function.parameters, and Toolset.toLangChain passes it as schema. Reach for it directly only when driving an API none of those cover.

A fresh object per Session.tools call, so a framework that normalises one in place is rewriting a copy and not the next caller's.

interface ToolParameters {
    type: "object";
    properties: Record<string, JsonSchema>;
    required: string[];
}
Index
type properties required
type: "object"

Always object: every operation takes named arguments.

properties: Record<string, JsonSchema>

One fragment per argument, each carrying a description.

required: string[]

The arguments the operation cannot be called without.

Quickstart