# ToolBuilder

## Overview

ToolBuilder is a builder class for constructing AI tool specifications with parameter definitions.

This class allows dynamic creation of tool specifications for AI agents, supporting string, number, and boolean parameters. It is designed to be used in scripting environments and integrates with Servoy's documentation system.

Usage example:

```js
ToolBuilder builder = new ToolBuilder(chatBuilder, toolFunction, "toolName", "Tool description");
builder.addStringParameter("param1", "Description", true)
       .addNumberParameter("param2", "Description", false)
       .build();
```

## Methods Summarized

| Type                                                                                            | Name                                                                                               | Summary                                                        |
| ----------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- |
| [ToolBuilder](https://docs.servoy.com/reference/servoyextensions/server-plugins/ai/toolbuilder) | [addBooleanParameter(name, description, required)](#addbooleanparameter-name-description-required) | Adds a boolean parameter to the tool specification.            |
| [ToolBuilder](https://docs.servoy.com/reference/servoyextensions/server-plugins/ai/toolbuilder) | [addNumberParameter(name, description, required)](#addnumberparameter-name-description-required)   | Adds a number parameter to the tool specification.             |
| [ToolBuilder](https://docs.servoy.com/reference/servoyextensions/server-plugins/ai/toolbuilder) | [addStringParameter(name, description, required)](#addstringparameter-name-description-required)   | Adds a string parameter to the tool specification.             |
| void                                                                                            | [build()](#build)                                                                                  | Finalizes the tool specification and returns the chat builder. |

## Methods Detailed

### addBooleanParameter(name, description, required)

Adds a boolean parameter to the tool specification.

**Parameters**

* [String](https://docs.servoy.com/reference/servoycore/dev-api/js-lib/string) **name** the parameter name
* [String](https://docs.servoy.com/reference/servoycore/dev-api/js-lib/string) **description** the parameter description
* [Boolean](https://docs.servoy.com/reference/servoycore/dev-api/js-lib/boolean) **required** whether the parameter is required

**Returns:** [ToolBuilder](https://docs.servoy.com/reference/servoyextensions/server-plugins/ai/toolbuilder) this ToolBuilder instance for chaining

### addNumberParameter(name, description, required)

Adds a number parameter to the tool specification.

**Parameters**

* [String](https://docs.servoy.com/reference/servoycore/dev-api/js-lib/string) **name** the parameter name
* [String](https://docs.servoy.com/reference/servoycore/dev-api/js-lib/string) **description** the parameter description
* [Boolean](https://docs.servoy.com/reference/servoycore/dev-api/js-lib/boolean) **required** whether the parameter is required

**Returns:** [ToolBuilder](https://docs.servoy.com/reference/servoyextensions/server-plugins/ai/toolbuilder) this ToolBuilder instance for chaining

### addStringParameter(name, description, required)

Adds a string parameter to the tool specification.

**Parameters**

* [String](https://docs.servoy.com/reference/servoycore/dev-api/js-lib/string) **name** the parameter name
* [String](https://docs.servoy.com/reference/servoycore/dev-api/js-lib/string) **description** the parameter description
* [Boolean](https://docs.servoy.com/reference/servoycore/dev-api/js-lib/boolean) **required** whether the parameter is required

**Returns:** [ToolBuilder](https://docs.servoy.com/reference/servoyextensions/server-plugins/ai/toolbuilder) this ToolBuilder instance for chaining

### build()

Finalizes the tool specification and returns the chat builder.

**Returns:** voidthe chat builder instance

***