Package com.github.copilot.sdk.json

Class ToolDef

java.lang.Object

com.github.copilot.sdk.json.ToolDef

public final class ToolDef
extends Object

Low-level tool definition for JSON-RPC communication.

This is an internal class representing the wire format of a tool. For registering tools with the SDK, use ToolDefinition instead.

Since:

1.0.0

See Also:

• ToolDefinition

Constructor Summary

Constructors

Constructor	Description
ToolDef()	Creates an empty tool definition.
ToolDef(String name, String description, Object parameters)	Creates a tool definition with all fields.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Gets the tool description.
String	getName()	Gets the tool name.
Object	getParameters()	Gets the JSON Schema for tool parameters.
void	setDescription(String description)	Sets the tool description.
void	setName(String name)	Sets the tool name.
void	setParameters(Object parameters)	Sets the JSON Schema for tool parameters.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ToolDef

public ToolDef()

Creates an empty tool definition.

ToolDef

public ToolDef(String name,
 String description,
 Object parameters)

Creates a tool definition with all fields.

Parameters:

name - the unique tool identifier

description - the tool description

parameters - the JSON Schema for tool parameters

Method Details

getName

public String getName()

Gets the tool name.

Returns:

the tool name

setName

public void setName(String name)

Sets the tool name.

Parameters:

name - the tool name

getDescription

public String getDescription()

Gets the tool description.

Returns:

the tool description

setDescription

public void setDescription(String description)

Sets the tool description.

Parameters:

description - the tool description

getParameters

public Object getParameters()

Gets the JSON Schema for tool parameters.

Returns:

the parameters schema

setParameters

public void setParameters(Object parameters)

Sets the JSON Schema for tool parameters.

Parameters:

parameters - the parameters schema