AI Tools Reference
This reference provides detailed information about all available Core Tools that AI Agents can use to interact with your geospatial data. Each tool entry includes a description, required parameters, and practical example showing how natural language requests translate into tool usage.
Map
Widget
Parameter
Map Tools
These tools let the Agent control the map position as well as extract the area of interest.
add_marker
Description
Add marker(s) on the map to display specific point locations.
Example
"Show me data around 31 Ratcliffe Court, Sweetman Place"
The agent geocodes the address and places a marker on the map to highlight the location.get_map_coordinates
Description
Retrieve the current map view coordinates and zoom level.
Input properties:
None required
Example
get_spatial_filter
Description
Get current area of interest (viewport or drawn polygon via Feature selection tool).
Input properties:
None required
Example
lds_geocode
Description
Convert address to coordinates.
Input properties
address (string): Input address to geocode.
country_code (string, optional): ISO 3166-1 alpha-2 country code (e.g., US, ES).
limit (integer, optional): Maximum number of results to return.
Example
set_map_center_and_zoom
Description
Center the map at specific coordinates with a defined zoom level.
Input properties:
center (array): Latitude and longitude coordinates [lat, lon].
zoom (number): Map zoom level as defined by Google Maps.
Example
set_map_center_and_zoom_to_layer
Description
Zoom the map view to a specific layer extent.
Input properties:
layerId (string): ID of the layer to frame in the viewport.
Example
set_spatial_filter
Description
Set, replace, or remove a spatial filter to focus analysis on a specific geographic area. When a spatial filter is active, all map viewport widgets and layers update to show only data within that region.
Input properties:
geometry (object): Valid and simple GeoJSON polygon geometry to define the spatial filter. Pass null to remove the current filter.
Example
Layer Tools
These tools let the Agent add, style and display layers on the map.
add_layer
Description
Visualize source data as new AI-generated layer on the map. It can generate new layers from existing sources or if query sources capability is available, it can also generate layers from AI-generated sources.
Input properties:
datasetId (string): The ID of the dataset to visualize.
label (string): Human-readable name for the layer.
hooverColumns (array, optional): Column names to show on hover (max 5).
hooverColumnsAggregation (object, optional): Aggregation methods for hover columns.
Example
set_layer_style
Description
Style AI-generated layers.
Input properties:
layerId (string): The ID of the layer to style.
opacity (number, optional): Layer transparency (0.0 to 1.0)
fillColor (string, optional): Hex color for fill (e.g. '
#FF0000')fillColorColumn (string, optional): Custom color palette.
radius (integer, optional): Point size in pixels.
radiusColumn (string, optional): Column to determine point sizes.
outlineColor (string, optional): Border color
outlineWidth (integer, optional): Border width in pixels.
Example
set_layer_visibility
Description
Control layer visibility on the map.
Input properties:
layers (array): Array of objects with:
layerId (string): The layer to control
visibility (boolean): Show (true) or hide (false)
mapIndex (number, optional): For split maps (0=left, 1=right)
Example
remove_layer
Description
Removes a temporal AI-generated layer.
Input properties:
layerId (string): The ID of the layer to be remove.
Example
Widget Tools
These tools let the Agent extract widget values and use them to filter data sources on the map.
filter_category_widget
Description
Filter by categories (e.g., type, region).
Input properties:
widgetId (string): The ID of the widget to filter.
categories (array): Selected category values to filter by.
Example
filter_histogram_widget
Description
Filter by distribution ranges.
Input properties:
widgetId (string): The ID of the widget to filter.
intervals (array): Array of [min, max] ranges.
Example
filter_range_widget
Description Filter by min/max values.
Input properties:
widgetId (string): The ID of the widget to filter
range (array): [min, max] values
Example
get_formula_widget
Description Retrieve calculated metrics (KPIs).
Input properties:
widgetId (string): The ID of the widget to read
Example
get_category_widget
Description Get category breakdowns.
Input properties:
widgetId (string): The ID of the widget to read.
Example
get_histogram_widget
Description Get distribution data.
Input properties:
widgetId (string): The ID of the widget to read.
Example
get_time_series_widget
Description Get temporal patterns.
Input properties:
widgetId (string): The ID of the widget to read.
timeRange (array): [start, end] timestamps in seconds since epoch.
Example
Parameter Tools
These tools let the Agent update parameter values on the map.
set_sql_parameter_text
Update text parameter values.
Input properties:
parameterId (string): ID of the parameter to update.
values (array): Array of text values to set.
Example
set_sql_parameter_date_range
Description Update date parameter values.
Input properties:
parameterId (string): ID of the parameter to update.
min (string, optional): Start date in ISO-8601 format (YYYY-MM-DD).
max (string, optional): End date in ISO-8601 format (YYYY-MM-DD).
Example
set_sql_parameter_numeric
Description Update numeric parameter value.
Input properties:
parameterId (string): ID of the parameter to update.
value (number): Numeric value to set.
Example
set_sql_parameter_numeric_range
Description Update numeric range parameter values.
Input properties:
parameterId (string): ID of the parameter to update.
min (number, optional): Minimum value.
max (number, optional): Maximum value.
Example
Data Tools
These tools let the Agent extract insights by generated SQL that is executed against your map connections. These can be used to provide insights in a conversational manner as well as for adding sources that then can be used to add AI-generated layers on the map.
These tools are off by default. You must enable Query source capability to use them. Maps with this capability enabled cannot be made public.
add_source
Description Load data from tables or queries that can be used.
Input properties:
type (string): Type of source (table, tileset, query, raster).
source (string): Table name or SQL query.
connection (string): Database connection name.
provider (string): Database provider type.
geoColumn (string, optional): Column containing geometry/geography.
Example
execute_query
Description Run SQL analysis (sync mode - immediate results).
Input properties:
connection_name (string): Connection name to execute against
sql (string): The SQL query to execute (SELECT statements only)
Example
remove_source
Description Remove AI-generated data sources.
Input properties:
datasetId (string): The ID of the dataset to remove.
Example
Workflows Output Tools
If a Workflows MCP Tool is provided to your Agent, your Agent automatically gets access to the following tools:
async_workflows_check_results
Description Check job status from Asynchronous Workflows execution. This is automatically invoked after async workflows execution.
Input properties:
jobId (string): The job Id to check status for.
Example
async_workflows_get_results
Description Get the results from Asynchronous Workflows execution.
Input properties:
jobId (string): The ID of the dataset to remove.
connection (string): Connection name for the output table.
Example
add_source_from_workflows
Description After workflows execution, this tool allows adding a new source on the map using the fully-qualified table result of Workflows, either Sync or Async modes.
Input properties:
source (string): The fully-qualified table name from Workflows output.
connection (string): Connection name for the output table.
Example
Last updated
Was this helpful?