Agents can use Tools during their execution. In addition to the Public Tools available by default, you can define Private Tools in your project.
This is a step-by-step guide to create and test a Private Tool.
First, log in to the Console. In the Project Dynamic combo box, select the project you want to work with; in this case, Documentation (Demo) is used.
Next, on the left side of the screen, you will find the Backoffice menu. In this menu, click on The Lab.
By clicking on The Lab in the Backoffice, a new window opens in the browser with The Lab.
Once inside The Lab, you will see the Side Navigation Menu on the left edge of the screen. If the menu is collapsed, click on the arrow icon to expand it.
In this menu, select the Tools option to access the Tools Dashboard.
The Tools Dashboard displays both Public and Private Tools for your Project by default.
Public Tools are identified with the message “This tool is read only.”
To create a new Private Tool, click on the + New Tool button in the upper-right corner.
Clicking on New Tool opens a new tab in the interface. This tab is organized into two sections: Configuration and JSON.
The Configuration tab appears by default. Here, you can set the details of the Tool.
This tab is divided into three collapsible panels:
- 3.1. Scope
- 3.2. Information
- 3.3. Parameters
This section defines the Tool’s connection to an external service. The Lab supports dynamic data retrieval via an OpenAPI specification, enabling Tools to interact with external APIs.
You must choose between two input options:
- URL: Allows you to enter the full URL of the OpenAPI specification.
- Json: Allows you to enter the JSON of the OpenAPI specification.
In this case, the Weather API is used. Since this API has an OpenAPI specification in JSON format, select the JSON option and paste the content in the Open API Json field.
This section controls how the Tool is visually represented and identified.
It includes the following fields:
- Tool Name (required): Provide a clear and specific name that follows the structure of the OpenAPI specification (operationId_HTTPmethod). This helps the system correctly identify and use the Tool’s operations. Read Configuration Tab of a Tool to understand the naming requirements.
In this case, the operationId is checkWeatherUsingGET and the method is GET, so the Tool name is: checkWeatherUsingGET_get.
- Description (optional): Add a brief explanation of the Tool’s purpose to help end users understand it at a glance.
This information will appear on the Tool’s card once it's created.
The Parameters section defines the inputs your Tool requires to operate. These values determine how the Tool processes incoming data and triggers external API requests.
In this case, it is not necessary to define parameters, so this section remains unchanged.
After completing the Configuration section, click on the JSON tab located in the upper-right corner of the interface.
This tab displays the complete configuration of the Tool in JSON format.
The content in this section is automatically generated based on the information you provided in the previous steps (Scope, Information, and Parameters).
Reviewing this JSON is useful to ensure all values were correctly registered and to get a full overview of your Tool's structure.
Once you’ve reviewed and confirmed the configuration, click on the Create Tool button located in the bottom-right corner of the screen.
Once you click on the Create Tool button, the defined name appears in the top tab next to Tools Dashboard. You can then click on the Publish button to publish the Tool and make it available for use within the project.
However, publishing is not required to start using the Tool during the Agent creation process. Every change or configuration is automatically saved as a draft. This allows the Tool to be added from the Agents & Tools to use section in the AI & Tools tab of any Agent—even if the Tool has not been published yet.
Keep in mind that if you intend to publish the Agent later, all associated Tools must be published beforehand. While draft Tools can be used freely during testing and development, they must be published to be included in a published Agent.