TomTom Maps for JavaScript
    Preparing search index...

    Type Alias ToolMetadata

    Metadata for an agent toolkit tool.

    type ToolMetadata = {
        alwaysActive?: boolean;
        classificationPrompt?: string;
        dependsOn?: ToolNameHint[];
        description: string;
        endsTurnOnCall?: boolean;
        examplePrompts?: string[];
        examples?: string[];
        name: string;
        relatedTools?: ToolNameHint[];
        scopePrompt?: string;
        tags?: string[];
    }
    Index
    alwaysActive? classificationPrompt? dependsOn? description endsTurnOnCall? examplePrompts? examples? name relatedTools? scopePrompt? tags?
    alwaysActive?: boolean

    Whether this tool stays active on every step regardless of the classifier's selection.

    classificationPrompt?: string

    Compact one-liner for the intent classifier prompt.

    dependsOn?: ToolNameHint[]

    Tool names that must run before this one.

    description: string

    Description of the tool's purpose, used by the SDK's system prompt.

    endsTurnOnCall?: boolean

    Whether to halt the agent loop on the step that calls this tool (no trailing step), e.g. clarifyIntent rendering a form.

    examplePrompts?: string[]

    Natural language prompts shown by the help tool (e.g. 'Where is the Louvre?').

    examples?: string[]

    Usage examples (e.g. 'geocode("Amsterdam")'), for a custom classifier. The help tool does not show them.

    name: string

    Tool identifier, derived from the config key.

    relatedTools?: ToolNameHint[]

    Tool names that are often used together with this tool.

    scopePrompt?: string

    When set, the classifier may emit toolScopes[name] for this tool to narrow per-turn.

    tags?: string[]

    Category tags used by the help tool for filtering (e.g. 'location', 'routing').

    Settings
    Member Visibility

    On This Page
    Properties