--- title: tool description: Helper function for tool type inference --- # `tool()` Tool is a helper function that infers the tool input for its `execute` method. It does not have any runtime behavior, but it helps TypeScript infer the types of the input for the `execute` method. Without this helper function, TypeScript is unable to connect the `inputSchema` property to the `execute` method, and the argument types of `execute` cannot be inferred. ```ts highlight={"1,4,9,10"} import { tool } from 'ai'; import { z } from 'zod'; export const weatherTool = tool({ description: 'Get the weather in a location', inputSchema: z.object({ location: z.string().describe('The location to get the weather for'), }), // location below is inferred to be a string: execute: async ({ location }) => ({ location, temperature: 72 + Math.floor(Math.random() * 21) - 10, }), }); ``` ## Import ## API Signature ### Parameters RESULT | Promise | AsyncIterable', description: 'An async function that is called with the arguments from the tool call and produces a result or a results iterable. If an iterable is provided, all results but the last one are considered preliminary. If not provided, the tool will not be executed automatically.', properties: [ { type: 'ToolCallOptions', parameters: [ { name: 'toolCallId', type: 'string', description: 'The ID of the tool call. You can use it e.g. when sending tool-call related information with stream data.', }, { name: 'messages', type: 'ModelMessage[]', description: 'Messages that were sent to the language model to initiate the response that contained the tool call. The messages do not include the system prompt nor the assistant response that contained the tool call.', }, { name: 'abortSignal', type: 'AbortSignal', isOptional: true, description: 'An optional abort signal that indicates that the overall operation should be aborted.', }, { name: 'experimental_context', type: 'unknown', isOptional: true, description: 'Context that is passed into tool execution. Experimental (can break in patch releases).', }, ], }, ], }, { name: 'outputSchema', isOptional: true, type: 'Zod Schema | JSON Schema', description: 'The schema of the output that the tool produces. Used for validation and type inference.', }, { name: 'toModelOutput', isOptional: true, type: "(output: RESULT) => LanguageModelV3ToolResultPart['output']", description: 'Optional conversion function that maps the tool result to an output that can be used by the language model. If not provided, the tool result will be sent as a JSON object.', }, { name: 'onInputStart', isOptional: true, type: '(options: ToolCallOptions) => void | PromiseLike', description: 'Optional function that is called when the argument streaming starts. Only called when the tool is used in a streaming context.', }, { name: 'onInputDelta', isOptional: true, type: '(options: { inputTextDelta: string } & ToolCallOptions) => void | PromiseLike', description: 'Optional function that is called when an argument streaming delta is available. Only called when the tool is used in a streaming context.', }, { name: 'onInputAvailable', isOptional: true, type: '(options: { input: INPUT } & ToolCallOptions) => void | PromiseLike', description: 'Optional function that is called when a tool call can be started, even if the execute function is not provided.', }, { name: 'providerOptions', isOptional: true, type: 'ProviderOptions', description: 'Additional provider-specific metadata. They are passed through to the provider from the AI SDK and enable provider-specific functionality that can be fully encapsulated in the provider.', }, { name: 'type', isOptional: true, type: "'function' | 'provider-defined'", description: 'The type of the tool. Defaults to "function" for regular tools. Use "provider-defined" for provider-specific tools.', }, { name: 'id', isOptional: true, type: 'string', description: 'The ID of the tool for provider-defined tools. Should follow the format `.`. Required when type is "provider-defined".', }, { name: 'name', isOptional: true, type: 'string', description: 'The name of the tool that the user must use in the tool set. Required when type is "provider-defined".', }, { name: 'args', isOptional: true, type: 'Record', description: 'The arguments for configuring the tool. Must match the expected arguments defined by the provider for this tool. Required when type is "provider-defined".', }, ], }, ], }, ]} /> ### Returns The tool that was passed in.