This article provides a comprehensive guide to understanding and managing projects within AgentRunner. Projects serve as organizational hubs for your agents, allowing you to categorize and manage them effectively. Whether you're a new user or an experienced agent builder, this guide will help you navigate the projects tab, create new projects, edit existing ones, and understand the various actions you can perform. AgentRunner is an agent builder platform in the SaaS industry, using a node editor, and this guide will help you make the most of its project management features.
Navigating the Projects Tab
The Projects tab is your central location for accessing and managing all your projects within AgentRunner. Understanding how to navigate this tab is crucial for efficient agent management. Think of projects as folders that contain your agents, similar to how you organize files on your computer. This structure allows you to group related agents together, making them easier to find and manage. The projects tab is located in the main menu, providing quick access to all your projects.
Project Organization
Effective project organization is essential for maintaining a clean and efficient workspace in AgentRunner. By categorizing your agents into relevant projects, you can quickly locate and manage them based on their functionality or purpose. This becomes especially important as you create more and more agents.
Categorization: Group agents based on their functionality, such as "Customer Support Agents," "Sales Automation Agents," or "Marketing Campaign Agents."
Naming Conventions: Use clear and consistent naming conventions for your projects to make them easily identifiable.
Icon Selection: Choose icons that visually represent the theme or purpose of each project to enhance organization.
Benefits of Using Projects
Projects offer several organizational and functional benefits beyond simply being folders for agents. They provide a structured way to manage your agents, making it easier to maintain and scale your agent-building efforts.
Enhanced Organization: Easily categorize and locate agents based on their functionality.
Reusability: Use agents within a project as nodes in other agents, promoting modularity and code reuse.
Improved Collaboration: Assign members to projects to facilitate teamwork and shared access to relevant agents.
Creating a New Project
Creating a new project in AgentRunner is a straightforward process that allows you to organize your agents effectively. Every user within the workspace has the permission to create a new project, making it accessible to all team members. When creating a new project, you'll have the opportunity to customize its appearance and assign members. This section will guide you through each step of the project creation process, ensuring you can quickly set up your projects and start organizing your agents.
Steps to Create a New Project
Follow these steps to create a new project in AgentRunner:
Navigate to the Projects Tab: Locate and click on the "Projects" tab in the main menu.
Click "New Project": Find and click the button labeled "New Project." This will open the project creation interface.
Select an Icon: Choose an icon from the available options. AgentRunner offers over 100 icons to choose from. For better organization, it's advised to pick icons that relate to the theme of each project.
Enter a Title: Provide a clear and descriptive title for your project. This title should reflect the purpose or category of the agents you plan to include in the project.
Add a Description: Write a brief description of the project. This description should provide additional context and help other users understand the project's purpose.
Assign Members: Add members to the project. When assigning members to a project, they gain the ability to view, run, and edit the agents within that project. There is no limit to the number of members you can assign. If you don't assign anyone, everyone will be able to view it.
Save the Project: Once you've completed all the above steps, save the project.
Customizing Your Project
Customizing your project with a relevant icon, title, and description can significantly improve organization and collaboration. Here are some tips for making the most of these features:
Icon Selection: Choose an icon that visually represents the project's theme or purpose. This will make it easier to identify the project at a glance.
Descriptive Title: Use a clear and concise title that accurately reflects the project's contents.
Detailed Description: Provide a brief description that outlines the project's goals and the types of agents it contains.
Editing and Managing Existing Projects
Once a project has been created, you can edit it to modify its settings, add or remove members, or perform other management tasks. The edit menu is located at the three dots in the top right corner of each project. Only the owners and developers can edit a project, ensuring that project settings are controlled by authorized personnel. This section will cover the various editing and management options available for projects in AgentRunner.
Editing Project Details
You can modify various aspects of a project, including its icon, title, and description. There are no restrictions on changing these elements, allowing you to update the project's appearance and purpose as needed. To edit a project:
Locate the Project: Find the project you want to edit in the Projects tab.
Open the Edit Menu: Click on the three dots in the top right corner of the project to open the edit menu.
Select "Edit": Choose the "Edit" option from the menu.
Make Changes: Modify the icon, title, or description as desired.
Save the Changes: Save the changes to apply them to the project.
Managing Project Members
You can also manage the members assigned to a project. This includes adding new members or removing existing ones. When you assign members to a project, they get to view, run, and edit the agents in this project. There is no limit to the number of members that can be assigned to a project.
Locate the Project: Find the project you want to manage in the Projects tab.
Open the Edit Menu: Click on the three dots in the top right corner of the project to open the edit menu.
Select "Manage Members": Choose the "Manage Members" option from the menu.
Add or Remove Members: Add new members by searching for their names and adding them to the projects. You can remove them by unticking the checkbox next to their name.
Save the Changes: Save the changes to apply them to the project.
Additional Actions
In addition to editing project details and managing members, you can also perform other actions from the edit menu:
Delete: Permanently remove the project. Deleting an agent is permanent and cannot be undone
Share: Share the project with others by clicking the button that creates a shortened URL. The shortened URL opens the shared project directly, however the user has to be logged in to be able to access it. Owners and developers can share the projects.
Conclusion
Understanding and effectively managing projects in AgentRunner is essential for organizing your agents, collaborating with team members, and streamlining your agent-building efforts. By following the guidelines outlined in this article, you can create, edit, and manage projects to suit your specific needs. Whether you're a new user or an experienced agent builder, mastering project management will help you make the most of AgentRunner's capabilities and build powerful, efficient agents.
