The Tool Registry is a crucial component of our platform that enables the registration and management of various tools. This document explains the structure of the Tool Registry and provides instructions on how to add new tools to it.

The Tool Registry relies on a registry.yaml file to maintain a comprehensive list of registered tools. Tools can be made public or private. In order for the tool registry configuration to be used, set the env TOOL_REGISTRY_CONFIG_PATH wherever this library is imported and used.

• registry.yaml helps register tools by specifying a tool image and version from a container registry.

• Public tools are openly accessible to all organizations and are readily available in the platform's Workflows page. These public tools are cataloged in public_tools.json. They are pulled from Docker hub and hence require no authentication.

• In contrast, private tools are documented in the private_tools.json file. This file is not tracked by git. These tools are meant for restricted or specialized use and are visible only to the running Unstract instance. They are generally pulled from a supported private container registry and hence require authentication.

1. Build the docker image for the tool that needs to be registered. This can be done with the Dockerfile residing in the tool's folder. Optionally this can be pushed to a registry of your choice.

   docker build --pull --rm -f "tools/<tool_folder>/Dockerfile" -t <image_name>:<image_tag>

2. Refer the sample_registry.yaml and create a new registry.yaml with your desired tools.

3. You can specify the tool's location using one of the following methods:

   • Local Path: If the tool is stored locally on your system, you can define it like this. The default tag is latest

     tools:
        - local:<tool_image_name>:<tool_image_tag>

   • Docker: If the tool is available as a Docker image, define it as follows. The default tag is latest

     tools:
        - docker:unstract/<tool_image_name>:<tool_image_tag>

4. Run the load_tools_to_json.py script. This script uses the registry.yaml file and updates the private_tools.json file.

5. Once the script has executed, the Tool Registry will be updated with the newly registered private tools.

6. Optionally in order to make the tool public, move the generated JSON to public_tools.json and commit the changes.

7. Users of the platform will be able to access and utilize all tools listed in both the user's private_tools.json and public_tools.json files. This ensures that all available tools are accessible to the platform's users, whether they are public or private.

By following these steps, you can effectively add new private tools to the Tool Registry and make them available within the platform, enhancing the capabilities and offerings of the system.