PluginBench
Skill
Official
Pass
Audit score 90

mapbox-search-patterns

mapbox/mapbox-agent-skills

Expert guidance on choosing the right Mapbox search tool and parameters for geocoding, POI search, and location discovery

What is mapbox-search-patterns?

This skill provides decision matrices and best practices for selecting between Mapbox's search_and_geocode_tool, category_search_tool, and reverse_geocode_tool. Use it when building location search features to optimize tool selection, spatial filtering (proximity/bbox/country), and parameter tuning for accurate, performant results.

  • Advises which Mapbox search tool to use based on query type (specific names vs. generic categories vs. coordinates)
  • Recommends spatial filtering strategies (proximity, bounding box, country constraints) with decision matrices
  • Guides parameter optimization including limit, types, and auto_complete settings
  • Provides tool selection decision matrix with 10+ real-world query examples
  • Explains trade-offs between proximity biasing, hard bbox constraints, and country filtering

How to install mapbox-search-patterns

npx skills add https://github.com/mapbox/mapbox-agent-skills --skill mapbox-search-patterns
Prerequisites
  • Mapbox API account with search tools enabled
  • Understanding of latitude/longitude coordinates and bounding box format
  • Familiarity with ISO 3166 country codes for country filtering
Claude Code
Cursor
Windsurf
Cline

How to use mapbox-search-patterns

  1. 1.Identify the query type: specific name/brand, generic category, or coordinates
  2. 2.Use the tool selection decision matrix to pick search_and_geocode_tool, category_search_tool, or reverse_geocode_tool
  3. 3.Determine spatial constraints: use proximity for location bias, bbox for hard area limits, or country for regional boundaries
  4. 4.Set additional parameters: limit (1-25 for categories), types (poi/address/place/etc.), and auto_complete (true for real-time typing)
  5. 5.Execute the selected tool with optimized parameters and return results sorted by relevance

Use cases

Good for
  • Building a location search feature that distinguishes between brand-name queries ('Starbucks on 5th Ave') and category queries ('coffee shops nearby')
  • Optimizing search performance by choosing appropriate result limits and spatial constraints for different UI contexts (autocomplete vs. map visualization)
  • Implementing country-specific search to disambiguate place names ('Paris, France' vs. 'Paris, Texas')
  • Converting GPS coordinates to human-readable addresses using reverse geocoding
  • Constraining search results to a service area or route corridor using bounding boxes
Who it's for
  • Backend developers building location search APIs
  • Frontend engineers implementing search-as-you-type interfaces
  • Product managers designing location discovery features
  • AI assistants helping users query Mapbox location services

mapbox-search-patterns FAQ

When should I use proximity vs. bbox?

Use proximity to bias results toward a location while allowing flexibility for highly relevant distant matches (e.g., 'pizza near me'). Use bbox for hard constraints when results must stay within a defined area (e.g., 'hotels in downtown Seattle'). Proximity is recommended for most user-facing queries.

What's the difference between search_and_geocode_tool and category_search_tool?

search_and_geocode_tool is for specific names, brands, and addresses ('Starbucks', 'Empire State Building', '123 Main St'). category_search_tool is for generic place types and categories ('coffee shops', 'restaurants', 'gas stations'). Brand names always use search_and_geocode_tool even in plural form.

Should I always set proximity when I have a user location?

Yes. The skill strongly recommends always setting proximity when you have a reference location. Without it, results are IP-based or global, which usually produces poor relevance. Proximity biases results toward the location without excluding distant matches.

What limit should I use for category_search_tool?

Use limit=5 for quick suggestions or autocomplete dropdowns, limit=10 for standard lists (default), and limit=25 for comprehensive searches or map visualizations. Lower limits return faster responses.

How do I disambiguate place names like 'Paris'?

Use the country parameter with ISO 3166 alpha-2 codes (e.g., country=['FR'] for Paris, France). You can also combine country with proximity and types filters for more precise results.

Full instructions (SKILL.md)

Source of truth, from mapbox/mapbox-agent-skills.


name: mapbox-search-patterns description: Expert guidance on choosing the right Mapbox search tool and parameters for geocoding, POI search, and location discovery

Mapbox Search Patterns Skill

Expert guidance for AI assistants on using Mapbox search tools effectively. Covers tool selection, parameter optimization, and best practices for geocoding, POI search, and location discovery.

Available Search Tools

1. search_and_geocode_tool

Best for: Specific places, addresses, brands, named locations

Use when query contains:

  • Specific names: "Starbucks on 5th Avenue", "Empire State Building"
  • Brand names: "McDonald's", "Whole Foods"
  • Addresses: "123 Main Street, Seattle", "1 Times Square"
  • Chain stores: "Target"
  • Cities/places: "San Francisco", "Portland"

Don't use for: Generic categories ("coffee shops", "museums")

2. category_search_tool

Best for: Generic place types, categories, plural queries

Use when query contains:

  • Generic types: "coffee shops", "restaurants", "gas stations"
  • Plural forms: "museums", "hotels", "parks"
  • Is-a phrases: "any coffee shop", "all restaurants", "nearby pharmacies"
  • Industry terms: "electric vehicle chargers", "ATMs"

Don't use for: Specific names or brands

3. reverse_geocode_tool

Best for: Converting coordinates to addresses, cities, towns, postcodes

Use when:

  • Have GPS coordinates, need human-readable address
  • Need to identify what's at a specific location
  • Converting user location to address

Tool Selection Decision Matrix

User QueryToolReasoning
"Find Starbucks on Main Street"search_and_geocode_toolSpecific brand name
"Find coffee shops nearby"category_search_toolGeneric category, plural
"What's at 37.7749, -122.4194?"reverse_geocode_toolCoordinates to address
"Empire State Building"search_and_geocode_toolSpecific named POI
"hotels in downtown Seattle"category_search_toolGeneric type + location
"Target store locations"search_and_geocode_toolBrand name (even plural)
"any restaurant near me"category_search_toolGeneric + "any" phrase
"123 Main St, Boston, MA"search_and_geocode_toolSpecific address
"electric vehicle chargers"category_search_toolIndustry category
"McDonald's"search_and_geocode_toolBrand name

Parameter Guidance

Proximity vs Bbox vs Country

Three ways to spatially constrain search results:

1. proximity (STRONGLY RECOMMENDED)

What it does: Biases results toward a location, but doesn't exclude distant matches

Use when:

  • User says "near me", "nearby", "close to"
  • Have a reference point but want some flexibility
  • Want results sorted by relevance to a point

Example:

{
  "q": "pizza",
  "proximity": {
    "longitude": -122.4194,
    "latitude": 37.7749
  }
}

Why this works: API returns SF pizza places first, but might include famous NYC pizzerias if highly relevant

Critical: Always set proximity when you have a reference location! Without it, results are IP-based or global.

2. bbox (Bounding Box)

What it does: Hard constraint - ONLY returns results within the box

Use when:

  • User specifies an area: "in downtown", "within this neighborhood"
  • Have a defined service area
  • Need to guarantee results are within bounds

Example:

{
  "q": "hotel",
  "bbox": [-122.51, 37.7, -122.35, 37.83] // [minLon, minLat, maxLon, maxLat]
}

Why this works: Guarantees all hotels are within SF's downtown area

Watch out: Too small = no results; too large = irrelevant results

3. country

What it does: Limits results to specific countries

Use when:

  • User specifies country: "restaurants in France"
  • Building country-specific features
  • Need to respect regional boundaries
  • Or it is otherwise clear they want results within a specific country

Example:

{
  "q": "Paris",
  "country": ["FR"] // ISO 3166 alpha-2 codes
}

Why this works: Finds Paris, France (not Paris, Texas)

Can combine: proximity + country + bbox or any combination of the three

Decision Matrix: Spatial Filters

ScenarioUseWhy
"Find coffee near me"proximityBias toward user location
"Coffee shops in downtown Seattle"proximity + bboxCenter on downtown, limit to area
"Hotels in France"countryHard country boundary
"Best pizza in San Francisco"proximity + country ["US"]Bias to SF, limit to US
"Gas stations along this route"bbox around routeHard constraint to route corridor
"Restaurants within 5 miles"proximity (then filter by distance)Bias nearby, filter results

Setting limit Parameter

category_search_tool only (1-25, default 10)

Use CaseLimitReasoning
Quick suggestions5Fast, focused results
Standard list10Default, good balance
Comprehensive search25Maximum allowed
Map visualization25Show all nearby options
Dropdown/autocomplete5Don't overwhelm UI

Performance tip: Lower limits = faster responses

types Parameter (search_and_geocode_tool)

Filter by feature type:

TypeWhat It IncludesUse When
poiPoints of interest (businesses, landmarks)Looking for POIs, not addresses
addressStreet addressesNeed specific address
placeCities, neighborhoods, regionsLooking for area/region
streetStreet names without numbersNeed street, not specific address
postcodePostal codesSearching by ZIP/postal code
districtDistricts, neighborhoodsArea-based search
localityTowns, villagesMunicipality search
countryCountry namesCountry-level search

Example combinations:

// Only POIs and addresses, no cities
{"q": "Paris", "types": ["poi", "address"]}
// Returns Paris Hotel, Paris Street, not Paris, France

// Only places (cities)
{"q": "Paris", "types": ["place"]}
// Returns Paris, France; Paris, Texas; etc.

Default behavior: All types included (usually what you want)

auto_complete Parameter (search_and_geocode_tool)

What it does: Enables partial/fuzzy matching

SettingBehaviorUse When
trueMatches partial words, typosUser typing in real-time
false (default)Exact matchingFinal query, not autocomplete

Example:

<!-- cspell:disable -->
// User types "starb"
{ "q": "starb", "auto_complete": true }
// Returns: Starbucks, Starboard Tavern, etc.

Use for:

  • Search-as-you-type interfaces
  • Handling typos ("mcdonalds" -> McDonald's)
<!-- cspell:enable -->
  • Incomplete queries

Don't use for:

  • Final/submitted queries (less precise)
  • When you need exact matches

Anti-Patterns to Avoid

Don't: Use category_search for brands

// BAD
category_search_tool({ category: 'starbucks' });
// "starbucks" is not a category, returns error

// GOOD
search_and_geocode_tool({ q: 'Starbucks' });

Don't: Use search_and_geocode for generic categories

// BAD
search_and_geocode_tool({ q: 'coffee shops' });
// Less precise, may return unrelated results

// GOOD
category_search_tool({ category: 'coffee_shop' });

Don't: Forget proximity for local searches

// BAD - Results may be anywhere globally
category_search_tool({ category: 'restaurant' });

// GOOD - Biased to user location
category_search_tool({
  category: 'restaurant',
  proximity: { longitude: -122.4194, latitude: 37.7749 }
});

Don't: Geocode ambiguous place names without proximity (REST too)

This applies to Mapbox Geocoding API v5 / Search Box in browser apps — not only MCP tools.

// BAD — limit=1 without proximity can resolve "Lincoln Memorial" to Illinois
fetch(`https://api.mapbox.com/geocoding/v5/mapbox.places/${encodeURIComponent(q)}.json?access_token=${token}&limit=1`);

// GOOD — bias to map center (and optional bbox)
fetch(
  `https://api.mapbox.com/geocoding/v5/mapbox.places/${encodeURIComponent(q)}.json` +
    `?access_token=${token}&proximity=-77.0369,38.9072&bbox=-77.15,38.79,-76.90,38.99&limit=1`
);

Also debounce search inputs (clearTimeout + setTimeout) so every keystroke does not fire a geocode.

Don't: Use bbox when you mean proximity

// BAD - Hard boundary may exclude good nearby results
search_and_geocode_tool({
  q: 'pizza',
  bbox: [-122.42, 37.77, -122.41, 37.78] // Tiny box
});

// GOOD - Bias toward point, but flexible
search_and_geocode_tool({
  q: 'pizza',
  proximity: { longitude: -122.4194, latitude: 37.7749 }
});

Don't: Request ETA unnecessarily

// BAD - Costs API quota for routing calculations
search_and_geocode_tool({
  q: 'museums',
  eta_type: 'navigation',
  navigation_profile: 'driving'
});
// User didn't ask for travel time!

// GOOD - Only add ETA when needed
search_and_geocode_tool({ q: 'museums' });
// If user asks "how long to get there?", then add ETA

Don't: Set limit too high for UI display

// BAD - Overwhelming for simple dropdown
category_search_tool({
  category: 'restaurant',
  limit: 25
});
// Returns 25 restaurants for a 5-item dropdown

// GOOD - Match UI needs
category_search_tool({
  category: 'restaurant',
  limit: 5
});

Quick Reference

Tool Selection Flowchart

User query contains...

-> Specific name/brand (Starbucks, Empire State Building)
  -> search_and_geocode_tool

-> Generic category/plural (coffee shops, museums, any restaurant)
  -> category_search_tool

-> Coordinates -> Address
  -> reverse_geocode_tool

-> Address -> Coordinates
  -> search_and_geocode_tool with types: ["address"]

Essential Parameters Checklist

For local searches, ALWAYS set:

  • proximity (or bbox if strict boundary needed)

For category searches, consider:

  • limit (match UI needs)
  • format (json_string if plotting on map)

For disambiguation, use:

  • country (when geographic context matters)
  • types (when feature type matters)

For travel-time ranking:

  • eta_type, navigation_profile, origin (costs API quota)

Common Mistakes

  1. Forgetting proximity -> Results are global/IP-based (or wrong state for ambiguous memorial/park names)
  2. Using wrong tool -> category_search for "Starbucks" (use search_and_geocode)
  3. Invalid category -> Check category_list first
  4. Bbox too small -> No results; use proximity instead
  5. Requesting ETA unnecessarily -> Adds API cost
  6. Limit too high for UI -> Overwhelming user
  7. Not filtering types -> Get cities when you want POIs
  8. No debounce on typeahead -> Quota burn and racy UI

Reference Files

Load these for deeper guidance on specific topics:

  • references/advanced-params.md — poi_category, ETA, format, and language parameters
  • references/workflows.md — Common patterns: Near Me, Branded, Geocoding, Category+Area, Reverse, Route-Based, Multilingual
  • references/optimization-combining.md — Performance optimization, combining tools, handling no results, category list resource