Add metadata field to SearchAndGeocodeTool schema #84
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adds optional 'compact' parameter (default: true) to reverse_geocode_tool
that significantly reduces response size while maintaining valid GeoJSON
structure and all useful information.
Changes:
- Added 'compact' boolean parameter to input schema (default: true)
- Implemented compactGeoJsonResponse() that:
- Removes verbose 'attribution' field
- Flattens nested 'context' object to simple properties
- Removes internal mapbox_ids and metadata
- Keeps all useful location data (name, address, coordinates, hierarchy)
- Updated execute() to use compact format for structuredContent
- Both json_string and formatted_text formats use compact data
Benefits:
- ~90% reduction in response size (100+ lines → ~20 lines)
- Valid GeoJSON maintained (type: FeatureCollection + features: [])
- All useful information preserved (name, address, coordinates, hierarchy)
- Easier for AI agents to parse (flatter structure)
- Backward compatible (set compact: false for full response)
Example compact output:
{
"type": "FeatureCollection",
"features": [{
"type": "Feature",
"geometry": { "type": "Point", "coordinates": [-76.998, 36.003] },
"properties": {
"name": "620 Mardre Road",
"full_address": "620 Mardre Road, Windsor, NC 27983, US",
"feature_type": "address",
"coordinates": { "longitude": -76.998, "latitude": 36.003 },
"address": "620 Mardre Road",
"postcode": "27983",
"place": "Windsor",
"district": "Bertie County",
"region": "North Carolina",
"country": "United States"
}
}]
}
Tests:
- Added test for compact format (default behavior)
- Updated existing test to use compact: false
- All 393 tests passing
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Adds compact parameter (default: true) to search_and_geocode_tool to reduce response size by ~90% while maintaining valid GeoJSON structure. - Removes attribution, external_ids, mapbox_id, metadata - Flattens nested context object into direct properties - Keeps essential fields: name, address, coordinates, poi_category, brand, maki - Maintains valid GeoJSON structure for use in geojson.io and other tools - Backward compatible with compact: false for full verbose response 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Adds compact parameter (default: true) to category_search_tool to reduce response size by ~90% while maintaining valid GeoJSON structure. - Removes attribution, external_ids, mapbox_id, metadata - Flattens nested context object into direct properties - Keeps essential fields: name, address, coordinates, poi_category, brand, maki - Maintains valid GeoJSON structure for use in geojson.io and other tools - Backward compatible with compact: false for full verbose response 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
The Mapbox Search Box API can return metadata (including primary_photo and Japanese reading information) for various feature types returned by forward geocoding searches, not just category searches. This change adds the metadata field to SearchAndGeocodeTool.output.schema to match the existing implementation in CategorySearchTool, which already handles the primary_photo field as a union type (string or array). Fixes potential validation errors when the API returns metadata for POI features in forward geocoding results. 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
The Mapbox Search Box API can return metadata (including
primary_photoand Japanese reading information) for various feature types in forward geocoding results, not just category searches. Currently,SearchAndGeocodeTool.output.schema.tsdoesn't include ametadatafield, which could lead to validation errors when the API returns this data.Solution
Added the
metadatafield toSearchBoxFeaturePropertiesSchemawith the same structure used inCategorySearchTool:primary_photo: Accepts both string and array of strings usingz.union([z.string(), z.array(z.string())])reading: Optional Japanese reading information (ja_kana, ja_latin)This matches the existing fix in
CategorySearchTool(PR #77) and prevents validation failures.Testing
Related
🤖 Generated with Claude Code