Adding Your Tools¶

This tutorial will guide you through the process of adding a new tool to the FRIDAY platform. We will use a simple example tool, create_folder.py, to demonstrate the process.

Step 1: Clone the Repository¶

First, you need to clone the repository containing the tools (referred to as “gizmos” for FRIDAY). Use the following command to clone the repository:

git clone https://github.com/OS-Copilot/FRIDAY-Gizmos.git

After cloning, navigate into the FRIDAY-Gizmos directory:

cd FRIDAY-Gizmos

Choose any Python file that represents the tool code you wish to add. For this tutorial, we will use Basic/create_folder.py as an example.

Step 2: Add the Tool to FRIDAY¶

To add your chosen tool to FRIDAY’s tool repository, run the action_manager.py script with the –add flag. You will need to provide the tool name and the path to the tool. Replace [tool_name] with the name you wish to give your tool and [tool_path] with the relative or absolute path to the tool file.

python oscopilot/tool_repository/manager/tool_manager.py --add --tool_name [tool_name] --tool_path [tool_path]

Note

[tool_name]: A unique identifier for your tool within the FRIDAY ecosystem. It is recommended to keep the tool_name the same as the class name for consistency.
[tool_path]: The path to the Python file you’re adding, relative to the FRIDAY installation directory or an absolute path.

Example: Adding a Tool¶

If we’re adding the create_folder.py tool located in the Basic directory and we wish to name it create_folder, the command would look like this:

python oscopilot/tool_repository/manager/tool_manager.py --add --tool_name create_folder --tool_path Basic/create_folder.py

Removing a Tool from FRIDAY¶

In addition to adding new tools to FRIDAY, you might find yourself in a situation where you need to remove an existing tool from the tool repository. Whether it’s for updating purposes or simply because the tool is no longer needed, removing a tool is straightforward.

To remove a tool from FRIDAY’s tool repository, you can use the action_manager.py script with the –delete flag. You will need to specify the name of the tool you wish to remove using the –tool_name option. Replace [tool_name] with the unique identifier for your tool within the FRIDAY ecosystem.

python oscopilot/tool_repository/manager/tool_manager.py --delete --tool_name [tool_name]

Note

[tool_name]: The unique identifier of the tool you want to remove from FRIDAY. Ensure that you provide the exact name as registered in FRIDAY’s tool repository to avoid any errors.

Example: Removing a Tool¶

If you wish to remove a tool named create_folder, the command would look like this:

python oscopilot/tool_repository/manager/tool_manager.py --delete --tool_name create_folder

This command will remove the create_folder tool from FRIDAY’s repository, effectively making it unavailable for future use within the ecosystem. It’s important to note that removing a tool is a permanent action, so make sure you’ve backed up any necessary code or information related to the tool before proceeding with the deletion.

Tool Code Example¶

To add a tool to FRIDAY, the tool code must follow a specific structure. Below is an example of a tool code that creates a folder either in a specified working directory or in the default working directory. This example adheres to the required structure for FRIDAY tools:

import os

def create_folder(working_directory, folder_name):
   """
   Create a folder under the specified working directory or the default working directory.

   Args:
   working_directory (str): The path of the working directory. If not provided, the default working directory will be used.
   folder_name (str): The name of the folder to be created. Default is 'myfold'.

   Returns:
   None
   """
   # Check if the working_directory is provided, if not, use the default working directory
   if working_directory:
      os.chdir(working_directory)

   # Create the folder
   os.makedirs(folder_name)

Tool Requirements¶

To ensure seamless integration into FRIDAY’s tool repository, your tool code must adhere to the following format, consistent with the example tools provided:

Python Package: Import any additional Python packages necessary for your tool’s functionality.
```
import os  # Example of importing another necessary package
```
Function Naming: The name of the function should be consistent with the tool’s file name to maintain clarity and ease of identification within the tool repository.

Function Comments: The funtion should include detailed explanations of the input and output parameters to guide the user.

def tool_name(parameter1, parameter2=None, *args, **kwargs):
    """
    Detailed explanation of what this function does, its parameters, and what it returns.
    """

By following these specific requirements, you ensure that your tool can be effectively integrated and utilized within the FRIDAY ecosystem. This consistency not only aids in tool management but also enhances the user experience by providing a standardized approach to tool development.

Conclusion¶

With the provided guidelines and example, you are now equipped to extend FRIDAY’s capabilities by adding new tools. By adhering to the structure and requirements specified for FRIDAY tools, you ensure that your tools can be effectively utilized within the FRIDAY ecosystem.

Remember, the power of FRIDAY lies in its flexibility and the collaborative efforts of its community. Your contributions help make FRIDAY more versatile and powerful.

We welcome you to submit your tools to the FRIDAY Gizmos repository at https://github.com/OS-Copilot/FRIDAY-Gizmos. Sharing your work enables others in the community to benefit from your contributions and further enhances the FRIDAY platform.

Happy coding!