Skip to content

Built-in Tools

NucleusIQ ships five file-oriented built-ins, sandboxed to a workspace_root, plus first-class WebSearchTool (v0.7.14):

  • FileReadTool
  • FileWriteTool
  • FileSearchTool
  • DirectoryListTool
  • FileExtractTool
  • WebSearchTool — public web search; DuckDuckGo by default (no API key)

Typical setup

from nucleusiq.tools.builtin import (
    FileReadTool,
    FileWriteTool,
    FileSearchTool,
    DirectoryListTool,
    FileExtractTool,
    WebSearchTool,
)

tools = [
    FileReadTool(workspace_root="./workspace"),
    FileWriteTool(workspace_root="./workspace"),
    FileSearchTool(workspace_root="./workspace"),
    DirectoryListTool(workspace_root="./workspace"),
    FileExtractTool(workspace_root="./workspace"),
    WebSearchTool(),
]

WebSearchTool is also exported from nucleusiq.tools. See Web search for provider=, allowlists, and how it differs from provider-hosted search.