Skip to main content
Glama
searchSchema.ts8.55 kB
/* * Copyright (C) 2025 TomTom NV * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ import { z } from "zod"; import { baseSearchParams, locationBiasParams, boundingBoxParams, poiFilterParams } from "./common"; export const tomtomFuzzySearchSchema = { query: z .string() .describe( "Natural language search query. Works with addresses, POI names, coordinates, or free-form text. Examples: 'restaurants near Central Park', 'IKEA stores', '52.3791,4.8994', 'coffee shops downtown'" ), ...baseSearchParams, ...locationBiasParams, ...boundingBoxParams, ...poiFilterParams, typeahead: z .boolean() .optional() .describe( "Enable autocomplete mode for partial queries. Use for search-as-you-type interfaces." ), radius: z .number() .optional() .describe( "Search radius in meters when lat/lon provided. Examples: 1000 (neighborhood), 5000 (city area), 20000 (metro area)." ), maxFuzzyLevel: z.number().optional().describe("Maximum fuzzy matching level (1-4)"), minFuzzyLevel: z.number().optional().describe("Minimum fuzzy matching level (1-4)"), entityTypeSet: z.string().optional().describe("Filter results by entity types"), ofs: z.number().optional().describe("Offset for pagination of results"), idxSet: z.string().optional().describe("Filter results by index set"), relatedPois: z.string().optional().describe("Include related points of interest"), gomList: z.boolean().optional().describe("Include geometry-only matches in the result list"), sort: z.string().optional().describe("Sort options for results"), ext: z.string().optional().describe("Extended parameters for the search"), connectors: z.boolean().optional().describe("Include connector information for EV stations"), roadUse: z.boolean().optional().describe("Include road usage information"), }; export const tomtomPOISearchSchema = { query: z .string() .describe( "Specific POI category search. Best for finding types of businesses: 'restaurants', 'gas stations', 'hotels', 'parking', 'ATMs', 'hospitals'" ), ...baseSearchParams, ...locationBiasParams, ...boundingBoxParams, ...poiFilterParams, radius: z .number() .optional() .describe( "Search radius in meters. Essential for focused local results. Examples: 1000 (walking), 5000 (driving), 20000 (wide area)." ), lat: z .number() .optional() .describe("Latitude for location context. STRONGLY recommended for relevant local results."), lon: z .number() .optional() .describe("Longitude for location context. Must be used with lat parameter."), typeahead: z .boolean() .optional() .describe("Autocomplete mode for partial queries. Use for search interfaces."), entityTypeSet: z.string().optional().describe("Filter results by entity types"), chargingAvailability: z .boolean() .optional() .describe("Include charging availability information for EV stations"), parkingAvailability: z.boolean().optional().describe("Include parking availability information"), fuelAvailability: z .boolean() .optional() .describe("Include fuel availability information for gas stations"), roadUse: z.boolean().optional().describe("Include road usage information"), minFuzzyLevel: z.number().optional().describe("Minimum fuzzy matching level (1-4)"), maxFuzzyLevel: z.number().optional().describe("Maximum fuzzy matching level (1-4)"), ofs: z.number().optional().describe("Offset for pagination of results"), relatedPois: z.string().optional().describe("Include related points of interest"), sort: z.string().optional().describe("Sort options for results"), ext: z.string().optional().describe("Extended parameters for the search"), }; export const tomtomNearbySearchSchema = { lat: z .number() .describe("Center latitude for nearby search. Use precise coordinates from geocoding."), lon: z .number() .describe("Center longitude for nearby search. Use precise coordinates from geocoding."), ...baseSearchParams, ...poiFilterParams, radius: z .number() .optional() .describe( "Search radius in meters. Default: 1000. Recommended: 500 (walking), 1000 (local), 5000 (driving), 20000 (wide area)." ), categorySet: z .string() .optional() .describe( "POI category filter. Common: '7315' (restaurants), '7309' (gas), '9663' (EV charging), '7311' (hotels), '9376' (parking)." ), entityTypeSet: z.string().optional().describe("Filter results by entity types"), chargingAvailability: z .boolean() .optional() .describe("Include charging availability information for EV stations"), parkingAvailability: z.boolean().optional().describe("Include parking availability information"), fuelAvailability: z .boolean() .optional() .describe("Include fuel availability information for gas stations"), minFuzzyLevel: z.number().optional().describe("Minimum fuzzy matching level (1-4)"), maxFuzzyLevel: z.number().optional().describe("Maximum fuzzy matching level (1-4)"), roadUse: z.boolean().optional().describe("Include road usage information"), ofs: z.number().optional().describe("Offset for pagination of results"), relatedPois: z.string().optional().describe("Include related points of interest"), sort: z.string().optional().describe("Sort options for results"), ext: z.string().optional().describe("Extended parameters for the search"), }; export const tomtomGeocodeSearchSchema = { query: z .string() .describe( "Full address to convert to coordinates. Include as much detail as possible (street, city, country) for accurate results. Examples: '1600 Pennsylvania Ave, Washington DC', 'Eiffel Tower, Paris, France'" ), ...baseSearchParams, ...locationBiasParams, ...boundingBoxParams, entityTypeSet: z .string() .optional() .describe( "Filter results by geographic entity types. Valid values: PostalCodeArea, CountryTertiarySubdivision, CountrySecondarySubdivision, MunicipalitySubdivision, MunicipalitySecondarySubdivision, Country, CountrySubdivision, Neighbourhood, Municipality. Note: This parameter is for geographic entities only, not POIs. For POI filtering, use categorySet instead" ), }; export const tomtomReverseGeocodeSearchSchema = { lat: z .number() .describe("Latitude coordinate (-90 to +90). Precision to 4+ decimal places recommended."), lon: z .number() .describe("Longitude coordinate (-180 to +180). Precision to 4+ decimal places recommended."), ...baseSearchParams, radius: z.number().optional().describe("Search radius in meters. Default: 100"), entityTypeSet: z .string() .optional() .describe("Filter by entity types: 'Country', 'Municipality', etc."), returnMatchType: z .boolean() .optional() .describe("Include information about the type of geocoding match achieved"), returnSpeedLimit: z .boolean() .optional() .describe("Include posted speed limit for street results"), returnRoadUse: z.boolean().optional().describe("Include road use types for street level results"), roadUse: z .array(z.string()) .optional() .describe( "Types of road use to include in the results. Examples: 'Arterial', 'Ferry', 'Highway', etc." ), allowFreeformNewLine: z.boolean().optional().describe("Allow newlines in freeform addresses"), returnAddressNames: z.boolean().optional().describe("Include address names in the response"), heading: z .number() .optional() .describe("Heading direction in degrees (0-360) for improved accuracy on roads"), maxResults: z.number().optional().describe("Maximum results to return (alias for limit)"), returnRoadAccessibility: z .boolean() .optional() .describe("Include road accessibility information"), returnCommune: z.boolean().optional().describe("Include commune information in the results"), ofs: z.number().optional().describe("Offset for pagination of results"), };

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/tomtom-international/tomtom-mcp'

If you have feedback or need assistance with the MCP directory API, please join our Discord server