Tools Reference
Complete reference for MCP tools.
MCP Tools Reference
Complete reference for all MCP tools.
list-locations
Find available locations for mapping.
GET /api/mcp/tools/list-locations
Parameters:
| Param | Type | Description |
|---|---|---|
type | string | country, subdivision, or city |
q | string | Search by name or code |
parent_id | string | Parent location UUID |
limit | number | Max results (default: 50) |
Example:
curl 'https://api.smavatar.com/api/mcp/tools/list-locations?type=subdivision&q=california'
get-location-details
Get detailed location information.
GET /api/mcp/tools/get-location-details
Parameters:
| Param | Type | Description |
|---|---|---|
id | string | Location UUID |
Example:
curl 'https://api.smavatar.com/api/mcp/tools/get-location-details?id=bdd56f14-e776-418a-ab18-89c8138df978'
list-features
Find rivers and lakes. Requires API key.
GET /api/mcp/tools/list-features
Parameters:
| Param | Type | Description |
|---|---|---|
location_id | string | Location UUID |
type | string | river or lake |
max_importance | number | Filter by importance (1–5) |
limit | number | Max results (default: 50) |
Example:
curl 'https://api.smavatar.com/api/mcp/tools/list-features?location_id=...' \
-H 'Authorization: Bearer sma_your_key'
list-themes
List available map themes.
GET /api/mcp/tools/list-themes
Example:
curl 'https://api.smavatar.com/api/mcp/tools/list-themes'
get-theme-details
Get theme styling information.
GET /api/mcp/tools/get-theme-details
Parameters:
| Param | Type | Description |
|---|---|---|
name | string | Theme name (e.g., modern) |
get-capabilities
Get explicit list of what SMAvatar supports. Use this to prevent hallucination.
GET /api/mcp/tools/get-capabilities
Response:
{
"supported": [
"country_maps",
"state_maps",
"subdivision_highlighting",
"rivers_and_lakes",
"multiple_themes"
],
"not_supported": [
"3d_maps",
"real_time_data",
"street_level_maps",
"custom_geodata_upload"
]
}
search-documentation
Search SMAvatar documentation.
GET /api/mcp/tools/search-documentation
Parameters:
| Param | Type | Description |
|---|---|---|
query | string | Search query (min 2 chars) |
section | string | Filter by section |
Example:
curl 'https://api.smavatar.com/api/mcp/tools/search-documentation?query=highlighting'
get-api-example
Get ready-to-use API examples.
GET /api/mcp/tools/get-api-example
Parameters:
| Param | Type | Description |
|---|---|---|
scenario | string | Example scenario |
Scenarios:
country-map— Simple country mapstate-with-rivers— State with water featuresstate-with-cities— State with city labelscountry-with-highlights— Quiz-style map
Example:
curl 'https://api.smavatar.com/api/mcp/tools/get-api-example?scenario=country-map'
get-use-case-examples
Get educational use case examples.
GET /api/mcp/tools/get-use-case-examples
Error Responses
Rate Limited (429)
{
"statusCode": 429,
"message": "Rate limit exceeded. Try again in 60 seconds."
}
API Key Required (401)
{
"statusCode": 401,
"message": "API key required for list-features. Sign up at smavatar.com"
}
Invalid Query (400)
{
"statusCode": 400,
"message": "Query must be at least 2 characters"
}