This is the documentation of version 0.47.9. Go to the latest version, 1.0.0.
TomTom Maps for JavaScript
    Preparing search index...

    Type Alias ToolMetadata

    Metadata for an agent toolkit tool.

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

    Properties

    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.

    examplePrompts?: string[]

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

    examples?: string[]

    Usage examples (e.g. 'geocode("Amsterdam")').

    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').