Skip to main content
Glama

Show Map Overlay

show_map_overlay

Shows or hides something on the open map from a plain request ('add US zip codes', 'hide the zips', 'show my accounts') or overlay_kind (part_layer, point_layer, tal, route) with overlay_id. Part layers load at a zoom where they are visible (visibility.camera_action); hiding a part layer leaves territories unchanged. Point layers must already be ingested; a layer in the Territory Solution but missing from the map is re-pushed (status=refreshed, with render_ack). Point layers have no hidden state: hide wording returns HIDE_NOT_SUPPORTED with do_this_next delete_point_layer, which removes the layer; the legend checkbox hides one in a single tab. route re-shows or hides routes calculate_route drew (route_id targets one); with no route yet it returns blocked_by=needs_route. When the user named a camera, do_this_next carries the configure_map call that sets it. Input: map_session_id (preferred) or ts_handle.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "show_map_overlay"
  }
}

Input Schema

NameRequiredDescriptionDefault
route_idNoWith overlay_kind=route, targets one route instead of all of them. Without it, every route is re-pushed or cleared. Only re-shows or clears a route calculate_route already produced — it never routes.
ts_handleNoTerritory Solution reference (tsh_...) from a build, ingest_accounts, import_geojson, import_designer_project, or get_map_visualization; Territory Solutions are not accepted inline.
overlay_idNoCanonical id: us_zips, accounts, tal-current, etc.
overlay_kindNo
user_requestNoNatural-language ask, e.g. 'add zips to the map'.
map_session_idNoOpen map session (msess_...) from get_map_visualization. Its Territory Solution is the input; omit ts_handle when set.
merge_strategyNo
expected_revisionNo
expected_content_hashNo

Output Schema

NameRequiredDescriptionDefault
okYes
errorNoPresent when ok is false.
resultNoPresent when ok is true.
warningsNo

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed10 schema fields changed
    • addedInput schema / properties / map_session_id / description
      Added value: +"Open map session (msess_...) from get_map_visualization. Its Territory Solution is the input; omit ts_handle when set."
    • addedInput schema / properties / overlay_id / description
      Added value: +"Canonical id: us_zips, accounts, tal-current, etc."
    • addedInput schema / properties / route_id / description
      Added value: +"With overlay_kind=route, targets one route instead of all of them. Without it, every route is re-pushed or cleared. Only re-shows or clears a route calculate_route already produced — it never routes."
    • removedInput schema / properties / ts
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "additionalProperties": true,
      -      "type": "object"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "default": null,
      -  "title": "Ts"
      -}
    • addedInput schema / properties / ts_handle / description
      Added value: +"Territory Solution reference (tsh_...) from a build, ingest_accounts, import_geojson, import_designer_project, or get_map_visualization; Territory Solutions are not accepted inline."
    • addedInput schema / properties / user_request / description
      Added value: +"Natural-language ask, e.g. 'add zips to the map'."
    • removedOutput schema / additionalProperties
      Removed value: -true
    • addedOutput schema / properties
      Added value: +{
      +  "error": {
      +    "description": "Present when ok is false.",
      +    "properties": {
      +      "ask_user": {
      +        "items": {
      +          "type": "string"
      +        },
      +        "type": "array"
      +      },
      +      "code": {
      +        "type": "string"
      +      },
      +      "details": {
      +        "type": "object"
      +      },
      +      "do_this_next": {
      +        "type": "object"
      +      },
      +      "message": {
      +        "type": "string"
      +      }
      +    },
      +    "type": "object"
      +  },
      +  "ok": {
      +    "type": "boolean"
      +  },
      +  "result": {
      +    "description": "Present when ok is true.",
      +    "properties": {
      +      "delegated_tool": {
      +        "type": [
      +          "null",
      +          "string"
      +        ]
      +      },
      +      "do_this_next": {
      +        "type": [
      +          "object",
      +          "string"
      +        ]
      +      },
      +      "map_push_status": {
      +        "type": "string"
      +      },
      +      "overlay_id": {
      +        "type": "string"
      +      },
      +      "overlay_kind": {
      +        "type": "string"
      +      },
      +      "route_id": {
      +        "type": [
      +          "null",
      +          "string"
      +        ]
      +      },
      +      "route_ids": {
      +        "items": {
      +          "type": "string"
      +        },
      +        "type": "array"
      +      },
      +      "status": {
      +        "type": "string"
      +      },
      +      "ts_handle": {
      +        "type": "string"
      +      },
      +      "viewer_hint": {
      +        "type": [
      +          "null",
      +          "string"
      +        ]
      +      },
      +      "visibility": {
      +        "type": "object"
      +      }
      +    },
      +    "type": "object"
      +  },
      +  "warnings": {
      +    "items": {
      +      "properties": {
      +        "code": {
      +          "type": "string"
      +        },
      +        "message": {
      +          "type": "string"
      +        }
      +      },
      +      "type": "object"
      +    },
      +    "type": "array"
      +  }
      +}
    • addedOutput schema / required
      Added value: +[
      +  "ok"
      +]
    • removedOutput schema / title
      Removed value: -"show_map_overlayDictOutput"
  2. Changed1 schema field changed
    • removedInput schema / properties / guidance_handle
      Removed value: -{
      -  "anyOf": [
      -    {
      -      "type": "string"
      -    },
      -    {
      -      "type": "null"
      -    }
      -  ],
      -  "default": null,
      -  "title": "Guidance Handle"
      -}
  3. First observed

TDQS

A4.4/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

Goes well beyond the annotations (readOnly=false, idempotent=false, destructive=false) by disclosing that part layers load at a visible zoom, that hiding a part layer leaves territories unchanged, that a missing point layer is re-pushed with status=refreshed and render_ack, and that point layers have no hidden state at all. These are the mutation side effects an agent needs before calling.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

Front-loads the action and scope, and every clause carries a concrete fact (zoom behavior, error codes, next-step tools) rather than filler. It is a single dense run-on paragraph with heavy parenthetical nesting, which makes it slower to parse than it needs to be.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a non-idempotent map-mutation tool with nine optional params, the description covers preconditions, side effects on territory data, per-kind edge cases, and outcome signals (status=refreshed, render_ack, blocked_by) — more than enough even though an output schema also exists.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Adds real meaning for the core selector parameters: map_session_id is preferred over ts_handle (with the source tools named), overlay_kind pairs with overlay_id, route_id targets a single route, and user_request takes plain language. However, three parameters at 56% schema coverage — merge_strategy, expected_revision, expected_content_hash — are explained in neither the schema nor the description, leaving the concurrency behavior of a non-idempotent mutation undocumented.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb pair (shows/hides) on the open map and then enumerates exactly what can be shown or hidden (part_layer, point_layer, tal, route). The opening 'something' is vague, but the enumeration plus named partners (calculate_route supplies routes, delete_point_layer removes point layers) make the tool's identity unambiguous against siblings.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Explicitly covers when-not cases and routes the agent onward: point-layer hide wording returns HIDE_NOT_SUPPORTED with do_this_next delete_point_layer, route with no prior route returns blocked_by=needs_route, and a user-named camera results in a configure_map call. Point layers 'must already be ingested' is stated as a precondition.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources