-
Notifications
You must be signed in to change notification settings - Fork 427
Open
Description
What improvement(s) are you suggesting?
Description
Currently, the tool guide documentation doesn't explain how to make tools actually appear in the UI. While setting is_visible: true and is_available: true in the tool configuration, tools still won't show up unless explicitly added to the default agent's tools list.
Current Behavior
- Tools can be properly configured but still not appear in the UI
- The critical configuration step in default_agent.py is not documented
- Users might spend time debugging why their tools aren't showing up
Suggested Change
Add a new section in docs/custom_tool_guides/tool_guide.md after "Step 3: Importing your Tool":
Step 3b: Enable your Tool in Default Agent
Important: After importing your tool, you need to enable it in the default agent configuration for it to appear in the UI.
- Open src/backend/config/default_agent.py
- Add your tool to the tools list in the get_default_agent() function:
def get_default_agent() -> AgentPublic:
return AgentPublic(
# ... other config ...
tools=[
Tool.Read_File.value.ID,
Tool.Search_File.value.ID,
Tool.Your_New_Tool.value.ID, # Add your tool here
],d
# ... rest of config ...
)
- Restart your backend service
Why This Matters
- Saves development time by clearly documenting all required steps
- Prevents confusion when tools don't appear as expected
- Improves the overall developer experience
Additional Context
This issue was discovered while trying to enable additional tools in the toolkit. The solution required searching through the codebase to find where tools are actually enabled.
Additional information
No response
Metadata
Metadata
Assignees
Labels
No labels