ai/src/generate-text/validate-tool-context.ts

AI SDK by Vercel - build apps like ChatGPT, Claude, Gemini, and more with a single interface for any model using the Vercel AI Gateway or go direct to OpenAI, Anthropic, Google, or any other model provider.

import { validateTypes, type FlexibleSchema } from '@ai-sdk/provider-utils';
/**
 * Validates a tool context value against the tool's optional context schema.
 *
 * When no context schema is defined, the original context value is returned as-is.
 * Otherwise, the context is validated and normalized through the schema before
 * being passed into tool execution and approval hooks.
 *
 * @throws {TypeValidationError} When the provided tool context does not match
 * the tool's declared `contextSchema`.
 */
export async function validateToolContext<CONTEXT>({
  toolName,
  context,
  contextSchema,
}: {
  toolName: string;
  context: unknown;
  contextSchema: FlexibleSchema<CONTEXT> | undefined;
}): Promise<CONTEXT> {
  if (contextSchema == null) {
    return context as CONTEXT;
  }

  return await validateTypes({
    value: context,
    schema: contextSchema,
    context: {
      field: 'tool context',
      entityName: toolName,
    },
  });
}