ToolDefinition

All Implemented Interfaces:


public interface ToolDefinition

Definition of a tool

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description

Constructor Summary

Constructors
Constructor	Description

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`String`	`getId()`	Tool id, default to tool's name
`abstract String`	`getName()`	Tool name
`abstract String`	`getDescription()`	Tool description
`String`	`getParametersSchema()`	JSON schema of tool's parameters
`String`	`getReturnTypeSchema()`	JSON schema of tool's return type
`String`	`getExamples()`	Examples to call this tool

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
- Method Detail
  - getId
```
 String getId()
```
    Tool id, default to tool's name
    
    Returns:
    
    tool id
  - getName
```
 abstract String getName()
```
    Tool name
    
    Returns:
    
    tool name
  - getDescription
```
 abstract String getDescription()
```
    Tool description
    
    Returns:
    
    tool description
  - getParametersSchema
```
 String getParametersSchema()
```
    JSON schema of tool's parameters
    
    Returns:
    
    Parameters schema
  - getReturnTypeSchema
```
 String getReturnTypeSchema()
```
    JSON schema of tool's return type
    
    Returns:
    
    Return type schema
  - getExamples
```
 String getExamples()
```
    Examples to call this tool
    
    Returns:
    
    Examples