import { FromSchema, JSONSchema } from 'json-schema-to-ts'; import { Promisable, BetaRunnableTool, BetaToolRunContext } from '../../lib/tools/BetaRunnableTool'; import { BetaToolResultContentBlockParam } from '../../resources/beta'; import { AutoParseableBetaOutputFormat } from '../../lib/beta-parser'; import { AnthropicError } from '../..'; import { transformJSONSchema } from '../../lib/transform-json-schema'; type NoInfer = T extends infer R ? R : never; /** * Creates a Tool with a provided JSON schema that can be passed * to the `.toolRunner()` method. The schema is used to automatically validate * the input arguments for the tool. */ export function betaTool & { type: 'object' }>(options: { name: string; inputSchema: Schema; description: string; run: ( args: NoInfer>, context?: BetaToolRunContext, ) => Promisable>; /** * Optional cleanup hook for tools that hold process-level resources (e.g. a * persistent shell). `client.beta.sessions.events.toolRunner` calls it once * when iteration ends. */ close?: () => void | Promise; }): BetaRunnableTool>> { if (options.inputSchema.type !== 'object') { throw new Error( `JSON schema for tool "${options.name}" must be an object, but got ${options.inputSchema.type}`, ); } return { type: 'custom', name: options.name, input_schema: options.inputSchema, description: options.description, run: options.run, parse: (content: unknown) => content as FromSchema, ...(options.close ? { close: options.close } : {}), } as any; } /** * Creates a JSON schema output format object from the given JSON schema. * If this is passed to the `.parse()` method then the response message will contain a * `.parsed_output` property that is the result of parsing the content with the given JSON schema. * */ export function betaJSONSchemaOutputFormat< const Schema extends Exclude & { type: 'object' }, >( jsonSchema: Schema, options?: { transform?: boolean; }, ): AutoParseableBetaOutputFormat>> { if (jsonSchema.type !== 'object') { throw new Error(`JSON schema for tool must be an object, but got ${jsonSchema.type}`); } const transform = options?.transform ?? true; if (transform) { // todo: doing this is arguably necessary, but it does change the schema the user passed in // so I'm not sure how we should handle that jsonSchema = transformJSONSchema(jsonSchema) as Schema; } return { type: 'json_schema', schema: { ...jsonSchema, }, parse: (content) => { try { return JSON.parse(content); } catch (error) { throw new AnthropicError(`Failed to parse structured output: ${error}`); } }, }; }