Components of tools

Components of tools in Agent Studio consist of an automatically generated template (tool.py & requirements.txt) with appropriate comments for each component of the tool.

The following components of a tool exist:
  • class UserParameters – Configuration parameters for external system interactions, for example, URLs, API keys. This class specifically holds parameters that the Large Language Model (LLM) cannot determine on its own.
  • class ToolParameters – Dynamic parameters determined by the LLM. The LLM uses the provided type and descriptive annotations for each parameter to suggest accurate values. This parameter-defining class must be nested within the main tool-defining class.
  • class <tool-name> – The primary tool definition class, which must inherit from StudioBaseTool. This class includes the tool name and description, both of which must be type-annotated as str. The tool operational logic resides within the its _run method.