Uses of Record Class
com.github.copilot.rpc.ToolDefinition

Packages that use ToolDefinition

Package	Description
com.github.copilot.rpc	Configuration classes and data transfer objects for the Copilot SDK.
com.github.copilot.tool

Uses of ToolDefinition in com.github.copilot.rpc

Methods in com.github.copilot.rpc that return ToolDefinition

Modifier and Type	Method	Description
static ToolDefinition	ToolDefinition.create(String name, String description, Map<String,Object> schema, ToolHandler handler)	Creates a tool definition with a JSON schema for parameters.
static ToolDefinition	ToolDefinition.createOverride(String name, String description, Map<String,Object> schema, ToolHandler handler)	Creates a tool definition that overrides a built-in CLI tool.
static ToolDefinition	ToolDefinition.createSkipPermission(String name, String description, Map<String,Object> schema, ToolHandler handler)	Creates a tool definition that skips the permission request.
static ToolDefinition	ToolDefinition.createWithDefer(String name, String description, Map<String,Object> schema, ToolHandler handler, ToolDefer defer)	Creates a tool definition with an explicit deferral mode.
ToolDefinition	ToolDefinition.defer(ToolDefer value)	Returns a copy with the defer mode set.
static <T1,T2,R> ToolDefinition	ToolDefinition.from(String name, String description, Param<T1> p1, Param<T2> p2, BiFunction<T1,T2,R> handler)	Creates a tool definition with a two-argument synchronous handler.
static <T1,R> ToolDefinition	ToolDefinition.from(String name, String description, Param<T1> p1, Function<T1,R> handler)	Creates a tool definition with a one-argument synchronous handler.
static <R> ToolDefinition	ToolDefinition.from(String name, String description, Supplier<R> handler)	Creates a tool definition with a zero-argument synchronous handler.
static <T1,T2,R> ToolDefinition	ToolDefinition.fromAsync(String name, String description, Param<T1> p1, Param<T2> p2, BiFunction<T1, T2, CompletableFuture<R>> handler)	Creates a tool definition with a two-argument asynchronous handler.
static <T1,R> ToolDefinition	ToolDefinition.fromAsync(String name, String description, Param<T1> p1, Function<T1, CompletableFuture<R>> handler)	Creates a tool definition with a one-argument asynchronous handler.
static <R> ToolDefinition	ToolDefinition.fromAsync(String name, String description, Supplier<CompletableFuture<R>> handler)	Creates a tool definition with a zero-argument asynchronous handler.
static <T1,R> ToolDefinition	ToolDefinition.fromAsyncWithToolInvocation(String name, String description, Param<T1> p1, BiFunction<T1, ToolInvocation, CompletableFuture<R>> handler)	Creates a tool definition with a one-argument asynchronous handler that also receives the ToolInvocation context.
static <R> ToolDefinition	ToolDefinition.fromAsyncWithToolInvocation(String name, String description, Function<ToolInvocation, CompletableFuture<R>> handler)	Creates a tool definition with a zero-argument asynchronous handler that receives the ToolInvocation context.
static <T1,R> ToolDefinition	ToolDefinition.fromWithToolInvocation(String name, String description, Param<T1> p1, BiFunction<T1, ToolInvocation, R> handler)	Creates a tool definition with a one-argument synchronous handler that also receives the ToolInvocation context.
static <R> ToolDefinition	ToolDefinition.fromWithToolInvocation(String name, String description, Function<ToolInvocation, R> handler)	Creates a tool definition with a zero-argument synchronous handler that receives the ToolInvocation context.
ToolDefinition	ToolDefinition.overridesBuiltInTool(boolean value)	Returns a copy with the overridesBuiltInTool flag set.
ToolDefinition	ToolDefinition.skipPermission(boolean value)	Returns a copy with the skipPermission flag set.

Methods in com.github.copilot.rpc that return types with arguments of type ToolDefinition

Modifier and Type	Method	Description
static List<ToolDefinition>	ToolDefinition.fromClass(Class<?> clazz)	Discovers tool definitions from a class with static @CopilotTool-annotated methods.
static List<ToolDefinition>	ToolDefinition.fromObject(Object instance)	Discovers tool definitions from an object whose methods are annotated with @CopilotTool.
List<ToolDefinition>	CreateSessionRequest.getTools()	Gets the tools.
List<ToolDefinition>	ResumeSessionConfig.getTools()	Gets the custom tools for this session.
List<ToolDefinition>	ResumeSessionRequest.getTools()	Gets the tools.
List<ToolDefinition>	SessionConfig.getTools()	Gets the custom tools for this session.

Method parameters in com.github.copilot.rpc with type arguments of type ToolDefinition

Modifier and Type	Method	Description
void	CreateSessionRequest.setTools(List<ToolDefinition> tools)	Sets the tools.
ResumeSessionConfig	ResumeSessionConfig.setTools(List<ToolDefinition> tools)	Sets custom tools that the assistant can invoke during the session.
void	ResumeSessionRequest.setTools(List<ToolDefinition> tools)	Sets the tools.
SessionConfig	SessionConfig.setTools(List<ToolDefinition> tools)	Sets custom tools that the assistant can invoke during the session.

Uses of ToolDefinition in com.github.copilot.tool

Methods in com.github.copilot.tool that return types with arguments of type ToolDefinition

Modifier and Type	Method	Description
List<ToolDefinition>	CopilotToolMetadataProvider.definitions(T instance, com.fasterxml.jackson.databind.ObjectMapper mapper)	Returns tool definitions for the given instance.