How do I add a tool description to my custom component which is built for tool mode.

[AakashKhatu]

when I click the edit Tools button the table is empty, I want to add the functions for tool use.
@dosu

[dosubot[bot]]

Hey @AakashKhatu! I'm here to help you with any bugs, questions, or contributions you have. Let's get started!

To add a tool description to your custom component built for tool mode and ensure the functions for tool use appear when you click the edit Tools button, follow these steps:

1. Define the Tool Description: Use the build_description function to construct the description for your tool. This function takes a Component and an Output as arguments and returns a formatted string that includes the method and component description.

   def build_description(component: Component, output: Output) -> str:
       if not output.required_inputs:
           logger.warning(f"Output {output.name} does not have required inputs defined")
   
       if output.required_inputs:
           args = ", ".join(
               sorted(
                   [
                       f"{input_name}: {_get_input_type(component._inputs[input_name])}"
                       for input_name in output.required_inputs
                   ]
               )
           )
       else:
           args = ""
       return f"{output.method}({args}) - {component.description}"

2. Ensure Tool Functions Appear: Use the get_tools method of the ComponentToolkit class to generate the tools. This method checks if the outputs are in tool mode and constructs the tools accordingly. It also uses the build_description function to set the description for each tool.

   def get_tools(
       self,
       tool_name: str | None = None,
       tool_description: str | None = None,
       callbacks: Callbacks | None = None,
       flow_mode_inputs: list[dotdict] | None = None,
   ) -> list[BaseTool]:
       tools = []
       for output in self.component.outputs:
           if self._should_skip_output(output):
               continue
   
           if not output.method:
               msg = f"Output {output.name} does not have a method defined"
               raise ValueError(msg)
   
           output_method: Callable = getattr(self.component, output.method)
           # ... (rest of the code)
           if asyncio.iscoroutinefunction(output_method):
               tools.append(
                   StructuredTool(
                       name=formatted_name,
                       description=build_description(self.component, output),
                       coroutine=_build_output_async_function(self.component, output_method, event_manager),
                       args_schema=args_schema,
                       handle_tool_error=True,
                       callbacks=callbacks,
                       tags=[formatted_name],
                   )
               )
           else:
               tools.append(
                   StructuredTool(
                       name=formatted_name,
                       description=build_description(self.component, output),
                       func=_build_output_function(self.component, output_method, event_manager),
                       args_schema=args_schema,
                       handle_tool_error=True,
                       callbacks=callbacks,
                       tags=[formatted_name],
                   )
               )
       # ... (rest of the code)
       return tools

3. Edit Tool Metadata: To edit a tool's metadata, click the Edit Tools button in the tool to modify its name or description metadata. These fields help connected agents understand how to use the tool without modifying the agent's prompt instructions.

By following these steps, you can add a description to your tool and ensure that the functions for tool use appear when you click the edit Tools button ^[1][2].

To continue talking to Dosu, mention @dosu.

---

^{Help Dosu learn! Give it feedback: Great Response | Irrelevant Answer | Incorrect Sources | Too Verbose | Hallucination | Bug Report | Other}

[AakashKhatu]

how can I add a row in the edit tool metadata dialoguebox from the UI? @dosu

[dosubot[bot]]

To add a row in the edit tool metadata dialog box from the UI, you can use the addRow function provided in the TableNodeComponent. This function is triggered when you click the "Add a new row" button. Here's how it works:

1. Locate the Add Row Button: In the UI, find the "Add a new row" button within the edit tool metadata dialog box.

2. Trigger the Add Row Function: When you click this button, the addRow function is executed. This function creates a new row with default values for each column and adds it to the table.

Here's a snippet of the addRow function:

function addRow() {
  const newRow = {};
  componentColumns.forEach((column) => {
    newRow[column.name] = column.default ?? null; // Use the default value if available
  });
  setTempValue([...tempValue, newRow]);
}

{addRow && !tableOptions?.block_add && (
  <div>
    <ShadTooltip content={"Add a new row"}>
      <Button data-testid="add-row-button" unstyled onClick={addRow}>
        <IconComponent
          name="Plus"
          className={cn("h-5 w-5 text-primary transition-all")}
        />
      </Button>
    </ShadTooltip>
  </div>
)}

This code ensures that a new row is added to the table when the button is clicked, allowing you to input new tool metadata directly from the UI ^[1][2].

To continue talking to Dosu, mention @dosu.

---

^{Help Dosu learn! Give it feedback: Great Response | Irrelevant Answer | Incorrect Sources | Too Verbose | Hallucination | Bug Report | Other}

[AakashKhatu]

@dosu

there isn't any button like that on the edit tools page

[dosubot[bot]]

The absence of the "Add a new row" button in the "Edit tools" modal could be due to specific conditions not being met. For the button to be visible, the following conditions must be satisfied:

1. The addRow function must be defined and not undefined.
2. The tableOptions object should not have the block_add property set to true ^[1].

If these conditions are not met, the button will not appear. You might want to check the implementation to ensure that the addRow function is correctly defined and that tableOptions?.block_add is not set to true. If these conditions are met and the button still doesn't appear, there might be an issue elsewhere in the code that needs to be investigated.

To continue talking to Dosu, mention @dosu.

---

^{Help Dosu learn! Give it feedback: Great Response | Irrelevant Answer | Incorrect Sources | Too Verbose | Hallucination | Bug Report | Other}