📄 ai-sdk/docs/reference/ai-sdk-ui/infer-ui-tools

File: infer-ui-tools.md | Updated: 11/15/2025

Source: https://ai-sdk.dev/docs/reference/ai-sdk-ui/infer-ui-tools

AI SDK

Menu

v5 (Latest)

AI SDK 5.x

AI SDK by Vercel

AI SDK 6 Beta

Foundations

Overview

Providers and Models

Prompts

Tools

Streaming

Getting Started

Navigating the Library

Next.js App Router

Next.js Pages Router

Svelte

Vue.js (Nuxt)

Node.js

Expo

Agents

Agents

Building Agents

Workflow Patterns

Loop Control

AI SDK Core

Overview

Generating Text

Generating Structured Data

Tool Calling

Model Context Protocol (MCP) Tools

Prompt Engineering

Settings

Embeddings

Image Generation

Transcription

Speech

Language Model Middleware

Provider & Model Management

Error Handling

Testing

Telemetry

AI SDK UI

Overview

Chatbot

Chatbot Message Persistence

Chatbot Resume Streams

Chatbot Tool Usage

Generative User Interfaces

Completion

Object Generation

Streaming Custom Data

Error Handling

Transport

Reading UIMessage Streams

Message Metadata

Stream Protocols

AI SDK RSC

Advanced

Reference

AI SDK Core

AI SDK UI

useChat

useCompletion

useObject

convertToModelMessages

pruneMessages

createUIMessageStream

createUIMessageStreamResponse

pipeUIMessageStreamToResponse

readUIMessageStream

InferUITools

InferUITool

AI SDK RSC

Stream Helpers

AI SDK Errors

Migration Guides

Troubleshooting

Copy markdown

InferUITools

========================================================================================

Infers the input and output types of a ToolSet.

This type helper is useful when working with tools in TypeScript to ensure type safety for your tool inputs and outputs in UIMessages.

Import


import { InferUITools } from 'ai';

API Signature


Type Parameters

TOOLS:

ToolSet

The tool set to infer types from.

Returns

A type that maps each tool in the tool set to its inferred input and output types.

The resulting type has the shape:

{  [NAME in keyof TOOLS & string]: {    input: InferToolInput<TOOLS[NAME]>;    output: InferToolOutput<TOOLS[NAME]>;  };}

Examples


Basic Usage

import { InferUITools } from 'ai';import { z } from 'zod';
const tools = {  weather: {    description: 'Get the current weather',    parameters: z.object({      location: z.string().describe('The city and state'),    }),    execute: async ({ location }) => {      return `The weather in ${location} is sunny.`;    },  },  calculator: {    description: 'Perform basic arithmetic',    parameters: z.object({      operation: z.enum(['add', 'subtract', 'multiply', 'divide']),      a: z.number(),      b: z.number(),    }),    execute: async ({ operation, a, b }) => {      switch (operation) {        case 'add':          return a + b;        case 'subtract':          return a - b;        case 'multiply':          return a * b;        case 'divide':          return a / b;      }    },  },};
// Infer the types from the tool settype MyUITools = InferUITools<typeof tools>;// This creates a type with:// {//   weather: { input: { location: string }; output: string };//   calculator: { input: { operation: 'add' | 'subtract' | 'multiply' | 'divide'; a: number; b: number }; output: number };// }

Related


On this page

InferUITools

Import

API Signature

Type Parameters

Returns

Examples

Basic Usage

Related

Deploy and Scale AI Apps with Vercel.

Vercel delivers the infrastructure and developer experience you need to ship reliable AI-powered applications at scale.

Trusted by industry leaders:

  • OpenAI
  • Photoroom
  • leonardo-ai Logoleonardo-ai Logo
  • zapier Logozapier Logo

Talk to an expert