Import a Tool

Using import functionality, you can create a new tool or add it as a version to an existing tool in your account. The import process preserves tool configuration while handling environment variables, errors, and role permissions.

When a tool is imported, its prompts, properties, and linked tools with their configurations are carried over. This ensures that the tool works seamlessly in the new system. Additionally, any models present in the exported tool — specifically external and open-source models — will be automatically linked and integrated. If any child tools are missing or there are conflicts, the system will notify you.

Creating a new tool involves importing a .zip package from your local system with the flow definition, app definition, and environment variables JSON files from another environment. During the creation journey, assign the imported tool a unique name to avoid conflicts with existing tool. Learn more.

When importing a tool version to a parent tool, the imported flow definition becomes the new in-dev version, overriding the flow, app definition, and environment variable files. The previous version is renamed and saved in the list, with optional backup of the current version available.

Once the import is complete, the tool flow canvas is updated with the latest configuration changes.

Note

Users with only Viewer permissions cannot import a tool.

Best Practices

• Export the tool first: Always export the current tool version before importing. This ensures you have all the necessary configurations.

• Check the environment and load dependencies: Ensure the new environment is set up with all required dependencies such as models, linked tools, and other configurations before importing. This helps ensure compatibility and smooth functionality after the import.

  • Verify that the correct model is already available in the new environment.
  • Ensure any linked tools are already present in the new environment, by the same name as it is preferred for auto-linking.
  • Check environment variables and configuration files to prevent any mismatches.

• Import the parent tool and version: After verifying the dependencies in the new environment, import the parent tool and any associated versions. Ensure there are no conflicts with existing tools.

Import to Create a New Tool

To initiate a tool creation journey through the import functionality, follow the steps below:

1. Sign in to your Agent Platform account.
2. Click Tools on the top menu.
3. Do one of the following based on your requirements:

• If you don't have any existing tools and want to create one by importing from another environment, click Import Tool.
• If you already have tools deployed, the following page is displayed. To import a tool, select the relevant tab on the Tools dashboard and click the Import tool icon.

4. In the Import tool window, providing the following information is mandatory.
• Tool Name: Provide a unique tool name.
• Flow definition file: Upload the required flow_definition.json file from your local directory. The file includes the tool's canvas definitions (node definitions) and AI node configurations, including prompts, hyperparameters, and timeout information.

Providing the following information is optional:

• App definition file: Upload the required app_definition.json file, which includes general information about the tool version and guardrails
• Environment variable file: Upload the required env_variables.json file, which includes the environment variables set for the tool.

Note

• The Import button is enabled when the required information is provided.
• AI node models and guardrail configurations may not be available in the current account. Reconfigure them before running the tool.
• The model name from the original tool is imported as a placeholder into the AI node's Select Model field. Later, you can assign a value from the available options.
• The values for System Prompt, Prompt, Timeout, and Hyperparameters are imported for the AI node.

5. Click Import.

Once the import is complete, the system will redirect you to the Tool Flow page, where you can access the new tool’s flow canvas by clicking Go to flow.

The imported tool is listed under All tools and My tools on the Tools dashboard.

Important

• The status of the imported tool is set to In Development.
• The node types, tool descriptions, input and output variables, scanners, and sync/async setup are kept intact during the import.
• If the AI node's model doesn't match any available models in the current account, the model field is kept empty, but all prompt definitions are imported.
• API keys are not transferred during the import process.
• The imported tool cannot be shared with other users.

Failure Scenarios

The import may fail due to an incompatible tool version, a corrupt file, an internal error, or missing guardrails in the current account, triggering an error notification.

Import Tool as a Version

Use the Import functionality under Tools > Configurations to add a tool as a version of a parent tool, replacing the existing one. You should back up the current in-development version to preserve its configuration definitions. The export file is saved as 'Exported_ToolName.zip.’

When you import an tool as a version, you must upload all the following files:

• Flow definition file: Upload the required flow_definition.json file from your local directory. The file includes the tool's canvas definitions (node definitions) and AI node configurations, including prompts, hyperparameters, and timeout information.
• App definition file: Upload the required app_definition.json file, which includes general information about the tool version and guardrails.
• Environment variable file: Upload the required env_variables.json file, which includes the environment variables set for the tool. Any conflicts between environment variables in the parent tool and the imported version must be resolved. Learn more.

Steps to Import a Tool

Note

To import a tool as a version, the parent tools must be deployed in your account.

To import a tool as a version, follow the steps below:

1. Sign in to your Agent Platform account.
2. Click Tools on the top menu.
3. Click the tool in the listing to proceed further.
4. Click Configurations on the left menu.

5. Scroll down to the Import tool section and click Import.

6. (Optional) In the following dialog, select the Back up your current tool option to preserve the data of the version being replaced.

   

Note

Backing up automatically exports and saves the .zip package of the tool definition files to the designated location when the import is initiated. Learn more

If you choose not to back up/export the tool configurations, unselect the back-up option and proceed to the next step.

7. Click Import in the confirmation dialog.
8. In the Import Tool window, upload the required JSON files and click Import.

Note

Tool Name is not required since the current version’s name is assigned.

The imported tool is validated, and if no errors exist, the tool is imported successfully.

The imported version is added under the parent tool.

Important

• The status of the parent tool is set to "In Development.”
• Updated on reflects the date the version was imported.

Conflicting Environment Variables

When importing environment variables during tool version import, conflicts may arise between those of the parent tool and the imported version. If neither tool has environment variables, no conflicts occur.

Important

Verify the environment variables before importing. For conflicting values, the existing ones are retained if not changed.

You must resolve conflicting variables by either keeping the existing value (of the version being replaced) or replacing them (with values from the imported tool) to ensure a smooth import process.

When conflicting environment variables are detected, it displays the following window. To resolve conflicts, follow the steps below:

1. Select the Conflicting variables tab.
2. Select either Overwrite to replace the existing variable with the imported one or select Keep existing.
3. Click Proceed to continue importing.

Editing Existing and Imported Variables

To resolve conflicts by editing either the existing or imported environment variables, select the relevant tab in the Edit Environment Variable window and follow the steps provided.

1. Click the Three-dots (Ellipsis) icon of the required variable.

2. Select Edit.
   

3. Change the required values in the Edit Variable window.

4. Click Save.
   

To cancel the import process during the conflicting environment variables resolution, click Cancel in the Edit Environment Variable window, and then click Confirm.

Related Links

• Create a Tool- Create a new tool and configure its flow.
• Export a Tool- Export the set configurations of a tool for data sharing and preservation.
• Deploy a Tool- Explore synchronous and asynchronous deployment methods for tool integration.
• Configure a Tool- Modify the tool's details, configure settings, or undeploy and delete it if unused.