Agents can use Tools from Integrations during their execution. In addition to the Public Integrations available by default, you can define Private Integrations in your Project.
This is a step-by-step guide to create and test a Private Integration.
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 Console Menu. In this menu, click on The Lab.
By clicking on The Lab in the Console, 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 Integrations option to access the Integrations Dashboard.
The Integrations Dashboard displays both Public and Private Integrations for your Project by default.
Public Integrations do not show the More Options link on the card.
To create a new Private Integration, click on the + Import Integration button in the upper-right corner.
Clicking + Import Integration opens the Import Integration dialog.
In this dialog, you must select the file that defines the Integration:
- Click on Upload or drag and drop the file into the Select File area.
- Once the file is selected, click on Read file.
The Lab supports JSON definitions based on OpenAPI and MCP. In this case, the Weather API is used.
After reading the file, the Integration Name field is filled with a suggested value based on the file contents. You can keep this suggestion or change it. The Description field is optional; you can add a short text that helps identify what the Integration is used for.
When you finish adjusting these values, click on Continue.
When the process finishes, a confirmation message indicates that "The Integration has been imported successfully". From here, you can either import more definitions or click on Edit Integration.
Clicking on Edit Integration opens the Integration in a new tab. The page is organized into three main sections:
- 4.1. Security Schema
- 4.2. Integration Parameters
- 4.3. Tool Parameters
In Security Schema, you define the basic information and authentication settings of the Integration.
Here you can:
- Review or adjust the Integration Name suggested from the imported file.
- Optionally provide a Description that summarizes what the Integration does.
- Optionally select an Authentication Level (for example, Project or User).
- Choose the Authentication type: None, API Key, or OAuth, according to the external service requirements.
In this case, no authentication is required, so Authentication type = None.
The Integration Parameters Tab defines configuration and connection values that apply to the Integration as a whole and are shared by all its Tools.
When no parameters have been defined, this tab shows an empty state. If your Integration needs shared values (for example, credentials or project-wide configuration), click on Add new parameter to create them.
Each Integration parameter includes fields such as:
- Key: Identifies the parameter.
- Type: Indicates how the value is provided (for example, Config).
- Value: Stores the value used in this Project.
- Data Type: Defines the kind of data expected (for example, String).
- Required: Specifies whether the parameter is mandatory.
- Secret: Marks values that must be stored as protected (for example, API keys).
In the case of the WeatherAPI Integration, it is not necessary to define Integration parameters, so you can leave this tab unchanged.
The Tool Parameters Tab lists the Tools that belong to the Integration and the parameters specific to each one.
Each Tool appears as a collapsible panel identified by its name. For Integrations imported from an OpenAPI definition, this name is generated automatically by the system based on the Integration and the operation (for example, weather-api_checkweatherusingget_get). You do not need to change or configure this name in this view.
When you expand a Tool, you can:
- Review the description that explains what the Tool does.
- Configure the parameters that the Tool needs to run, such as input fields or operation-specific options.
Each Tool parameter includes fields such as Key, Type, Value, Data Type, Required, and Secret, following the same structure used in Integration Parameters.
In the WeatherAPI Integration, the weather-api_checkweatherusingget_get Tool exposes an Application parameter called location, which indicates the place for which the weather information is requested and whose value is filled in dynamically at runtime based on the end-user input.
Once the Integration is imported and configured, it becomes available in the Project.
From the AI and Tools Tab of an Agent, you can:
- Enable the Tools that belong to the Integration.
- Combine them with other Tools that the Agent needs.
Any configuration you defined in Integration Parameters and Tool Parameters is applied when the Agent invokes these Tools during execution.