useBackendTool

Agent Runtimes

---

Agent Runtimes / components/hooks/useTools / useBackendTool

Function: useBackendTool()

useBackendTool(tool, dependencies?): void

Defined in: hooks/useTools.tsx:128

Hook to register a backend tool Backend tools are executed server-side via the inference provider

Parameters

tool

description

string

name

string

parameters

ToolParameter[]

render?

(props) => ReactNode

dependencies?

unknown[] = []

Returns

void

Example

useBackendTool({
  name: 'search_database',
  description: 'Search the database for records',
  parameters: [
    { name: 'query', type: 'string', required: true }
  ],
  render: ({ status, result }) => (
    <SearchResults status={status} results={result} />
  )
}, []);