TomTom Maps for JavaScript
    Preparing search index...

    Type Alias ToolBuildOptions<Scope>

    Build-time options passed to a ToolEntryBuilder. Lets each tool tailor its description, schema, or executor to flags or per-turn scope resolved by the classifier.

    type ToolBuildOptions<Scope = unknown> = {
        enabledDataKinds?: readonly EntryDataKind[];
        featureFlags?: FeatureFlags;
        scope?: Scope;
    }

    Type Parameters

    • Scope = unknown

      The per-tool scope shape. Defaults to unknown for the generic builder signature; individual builders narrow this via their own Scope generic so the scope argument is well-typed within the tool.

    Index

    Properties

    enabledDataKinds? featureFlags? scope?

    Properties

    enabledDataKinds?: readonly EntryDataKind[]

    Subset of EntryDataKind the agent is configured to expose, derived from createMapAgent's dataEntries option. Builders for analyseData and processData use this to narrow their static (unscoped) input surface to the agent's enabled kinds. undefined means "no agent-level filtering — every kind stays available".

    featureFlags?: FeatureFlags

    Active feature flags.

    scope?: Scope

    Per-turn scope emitted by the classifier (already validated against the tool's ToolEntry.scopeSchema). undefined at agent-creation time or when the classifier omits a scope for this tool — builders should treat undefined as "produce the full surface".

    Settings

    Member Visibility

    On This Page

    Properties