Tools Reference

Complete reference for MCP tools.

MCP Tools Reference

Complete reference for all available MCP tools.

Discovery Tools

list-locations

Find available locations for mapping.

GET /api/mcp/tools/list-locations

Parameters:

ParamTypeDescription
typestringcountry, subdivision, or city
qstringSearch query
parentstringParent location code (e.g., us)
limitnumberMax results (default: 50)

Example:

curl 'https://api.smavatar.com/api/mcp/tools/list-locations?type=subdivision&q=california'

get-location-details

Get detailed information about a location.

GET /api/mcp/tools/get-location-details

Parameters:

ParamTypeDescription
idstringLocation 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 for a location. Requires API key.

GET /api/mcp/tools/list-features

Parameters:

ParamTypeDescription
location_idstringLocation UUID
typestringriver or lake
max_importancenumberFilter by importance (1-5)
limitnumberMax 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 detailed theme styling information.

GET /api/mcp/tools/get-theme-details

Parameters:

ParamTypeDescription
namestringTheme name (e.g., modern)

get-capabilities

Get explicit list of what SMAvatar can and cannot do. 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"
  ]
}

Learning Tools

search-documentation

Search SMAvatar documentation.

GET /api/mcp/tools/search-documentation

Parameters:

ParamTypeDescription
querystringSearch query (min 2 chars)
sectionstringFilter 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:

ParamTypeDescription
scenariostringExample scenario

Scenarios:

  • country-map - Simple country map
  • state-with-rivers - State with water features
  • state-with-cities - State with city labels
  • highlighted-region - Quiz-style highlighted 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

Example:

curl 'https://api.smavatar.com/api/mcp/tools/get-use-case-examples'

Error Responses

Rate Limited (429)

{
  "statusCode": 429,
  "message": "Anonymous rate limit. Use API key for 10x higher limits."
}

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"
}

Next Steps

MCP Overview

Learn about MCP integration.

Examples

See example LLM conversations.

Built with Nuxt UI • © 2025