Function: required()

function required(field): ToolResponse;

Defined in: packages/core/src/core/response.ts:188

Create a validation error for a missing required field.

Convenience shortcut for error(\Error: ${field} required`)`. Typically used in handlers that accept dynamic or optional schemas.

Parameters

Parameter	Type	Description
field	string	Name of the missing required field

Returns

ToolResponse

A ToolResponse with isError: true

Example

handler: async (ctx, args) => {
    if (!args.workspace_id) return required('workspace_id');
    // ...
}

See

error for general error responses