description: string

A description of the namespace shown to the model.

name: string

The namespace name used in tool calls (for example, crm).

minLength1
tools: Array<Function { name, type, allowed_callers, 6 more } | BetaCustomTool { name, type, allowed_callers, 4 more } >

The function/custom tools available inside this namespace.

minItems1
One of the following:
Function { name, type, allowed_callers, 6 more }
name: string
minLength1
maxLength128
type: "function"
allowed_callers?: Array<"direct" | "programmatic"> | null

The tool invocation context(s).

minItems1
One of the following:
"direct"
"programmatic"
async?: boolean

Whether the tool response can be returned asynchronously versus immediately returned on next response creation.

defer_loading?: boolean

Whether this function should be deferred and discovered via tool search.

description?: string | null
output_schema?: Record<string, unknown> | null

A JSON Schema describing the JSON value encoded in string outputs for this function tool. This does not describe content-array outputs.

parameters?: unknown
strict?: boolean | null

Whether to enforce strict parameter validation. If omitted, Responses attempts to use strict validation when the schema is compatible, and falls back to non-strict validation otherwise.

BetaCustomTool { name, type, allowed_callers, 4 more }

A custom tool that processes input using a specified format. Learn more about custom tools

name: string

The name of the custom tool, used to identify it in tool calls.

type: "custom"

The type of the custom tool. Always custom.

allowed_callers?: Array<"direct" | "programmatic"> | null

The tool invocation context(s).

minItems1
One of the following:
"direct"
"programmatic"
async?: boolean

Whether the tool response can be returned asynchronously versus immediately returned on next response creation.

defer_loading?: boolean

Whether this tool should be deferred and discovered via tool search.

description?: string

Optional description of the custom tool, used to provide more context.

format?: Text { type } | Grammar { definition, syntax, type }

The input format for the custom tool. Default is unconstrained text.

One of the following:
Text { type }

Unconstrained free-form text.

type: "text"

Unconstrained text format. Always text.

Grammar { definition, syntax, type }

A grammar defined by the user.

definition: string

The grammar definition.

syntax: "lark" | "regex"

The syntax of the grammar definition. One of lark or regex.

One of the following:
"lark"
"regex"
type: "grammar"

Grammar format. Always grammar.

type: "namespace"

The type of the tool. Always namespace.