Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: Missing crucial step for enabling tools in UI #938

Open
mystico53 opened this issue Feb 10, 2025 · 0 comments
Open

Documentation: Missing crucial step for enabling tools in UI #938

mystico53 opened this issue Feb 10, 2025 · 0 comments

Comments

@mystico53
Copy link

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.

  1. Open src/backend/config/default_agent.py
  2. 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 ...
    )
  1. 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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant