Skip to main content

Function: tool()

tool<PARAMETERS, RETURN_TYPE, ADDITIONAL_DATA, CONTEXT>(tool): ExtendedTool<PARAMETERS, RETURN_TYPE, ADDITIONAL_DATA, CONTEXT>

Defined in: packages/core/src/utils/create-assistant.ts:151

Extends the vercel AI tool (see https://sdk.vercel.ai/docs/reference/ai-sdk-core/tool) with additional properties:

  • execute: updated execute function that returns {llmResult, output}, where llmResult will be sent back to the LLM and output (optional) will be used for next tool call or tool component rendering
  • context: get additional context for the tool execution, e.g. data that needs to be fetched from the server
  • component: tool component (e.g. chart or map) can be rendered as additional information of LLM response

Example:​

{
  weather: tool({
    description: 'Get the weather in a location',
    parameters: z.object({
      location: z.string().describe('The location to get the weather for'),
    }),
    execute: async ({ location }) => {
      // get the weather from the weather API
      // the result should contains llmResult and output
      // `llmResult` will be sent back to the LLM
      // `output` (optional) will be used for next tool call or tool component rendering
      return {
        llmResult: 'Weather in ' + location,
        output: {
          temperature: 72 + Math.floor(Math.random() * 21) - 10,
        },
      };
    },
  }),
}

Type Parameters​

• PARAMETERS extends Parameters = never

• RETURN_TYPE = never

• ADDITIONAL_DATA = never

• CONTEXT = never

Parameters​

tool​

ExtendedTool<PARAMETERS, RETURN_TYPE, ADDITIONAL_DATA, CONTEXT>

The vercel AI tool to extend

Returns​

ExtendedTool<PARAMETERS, RETURN_TYPE, ADDITIONAL_DATA, CONTEXT>

The extended tool