foundry_tool: Define an R function as a Responses API tool

In foundryR: Data Frame Workflows for 'Microsoft Foundry'

Define an R function as a Responses API tool

Description

Create a tool definition for foundry_response() or foundry_agent(). The request sent to Azure uses the Responses API function-tool contract, while the returned object also keeps the R function needed for local dispatch.

Usage

foundry_tool(fun, name = NULL, description, parameters)

Arguments

fun	Function. The R function to run when the model calls the tool.
name	Character. Tool name exposed to the model. If omitted and fun is a named function object, the object name is used.
description	Character. Short description of what the tool does.
parameters	List. JSON Schema object describing function arguments.

Value

A foundry_tool object. It is a list containing the JSON tool schema and the R function used by foundry_agent().

Examples

get_weather <- function(location) {
  list(location = location, temperature = "70 F")
}

weather_tool <- foundry_tool(
  get_weather,
  description = "Get weather for a location",
  parameters = list(
    type = "object",
    properties = list(location = list(type = "string")),
    required = "location"
  )
)

foundryR documentation built on Sept. 25, 2026, 1:10 a.m.