Function createMapAgent

createMapAgent<CS extends ToolState = ToolState>(
map: TomTomMap,
options: MapAgentOptions<CS>,
): MapAgentInstance<CS>

Creates a conversational agent toolkit that gives an LLM control over a TomTom map.

Returns a ToolLoopAgent instance (compatible with DirectChatTransport) with state and destroy attached. Classification runs transparently inside prepareStep — no wrapper type needed.

Type Parameters

CS extends ToolState = ToolState

Parameters

map: TomTomMap
The TomTomMap instance to control
options: MapAgentOptions<CS>
Agent configuration options

Returns MapAgentInstance<CS>

A ToolLoopAgent with state access and cleanup

Example: Basic usage

import { createMapAgent } from '@tomtom-org/maps-sdk-plugin-agent-toolkit';
import { openai } from '@ai-sdk/openai';
import { DirectChatTransport } from 'ai/react';

const agent = createMapAgent(map, { model: openai('gpt-4o') });

// Works directly with DirectChatTransport — no .agent property needed
const { messages, sendMessage } = useChat({
  transport: new DirectChatTransport({ agent }),
});

Example: Custom tools + removal

const agent = createMapAgent(map, {
  model: openai('gpt-4o'),
  tools: {
    getCustomLocation: myLocationTool,  // add custom
    setLanguage: false,                 // remove default
  },
});