Skip to main content
Glama
flowsery

flowsery

Official

Get Live Visitor Map

get_realtime_map
Read-onlyIdempotent

Map visitors active on a website in the last five minutes with approximate city-level locations for a live view; uses a website selector and returns no IP addresses or identifying details.

Instructions

Get the visitors active on the user's own website in the last 5 minutes with their approximate city-level location, for a live map view. Coordinates are rounded to 0.1 degrees, and no IP addresses or other identifying details are returned. Use get_realtime when only the count matters, and get_countries or get_cities for geography over a historical date range. Takes only the website selector: no dates, filters, or pagination. Poll no more than once every 5 seconds. Requires websiteId or domain with a workspace token.

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

Input Schema

NameRequiredDescriptionDefault
domainNoWebsite domain from list_websites (e.g. "example.com"). Alternative to websiteId with a workspace token.
websiteIdNoWebsite ID from list_websites. Required with a workspace token unless domain is given; ignored with a website key.
workspaceIdNoWorkspace to act in: an id from list_workspaces. Omit to use the default workspace. Use the same workspaceId for every call about the same workspace, since ids from one workspace do not exist in another

Output Schema

NameRequiredDescriptionDefault
resultYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed9 schema fields changedv1.5.0
    • removedInput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • addedInput schema / properties / workspaceId
      Added value: +{
      +  "description": "Workspace to act in: an id from list_workspaces. Omit to use the default workspace. Use the same workspaceId for every call about the same workspace, since ids from one workspace do not exist in another",
      +  "type": "string"
      +}
    • removedOutput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • addedOutput schema / properties / result / additionalProperties
      Added value: +true
    • removedOutput schema / properties / result / description
      Removed value: -"Object with status and data: up to 1000 active visitors, each with visitorId, country, countryCode, region, city, latitude, longitude, browser, os, deviceType, currentUrl, referrer, pageviews, totalRevenue, isCustomer, and name/email when identified."
    • addedOutput schema / properties / result / properties
      Added value: +{
      +  "data": {
      +    "description": "Up to 1000 active visitors. Names, emails and per-visitor revenue are left out",
      +    "items": {
      +      "additionalProperties": true,
      +      "properties": {
      +        "browser": {
      +          "$ref": "#/properties/result/properties/data/items/properties/visitorUid"
      +        },
      +        "city": {
      +          "$ref": "#/properties/result/properties/data/items/properties/visitorUid"
      +        },
      +        "country": {
      +          "$ref": "#/properties/result/properties/data/items/properties/visitorUid"
      +        },
      +        "countryCode": {
      +          "$ref": "#/properties/result/properties/data/items/properties/visitorUid"
      +        },
      +        "currentUrl": {
      +          "$ref": "#/properties/result/properties/data/items/properties/visitorUid"
      +        },
      +        "deviceType": {
      +          "$ref": "#/properties/result/properties/data/items/properties/visitorUid"
      +        },
      +        "latitude": {
      +          "description": "Rounded to 0.1 degrees",
      +          "type": [
      +            "number",
      +            "null"
      +          ]
      +        },
      +        "longitude": {
      +          "$ref": "#/properties/result/properties/data/items/properties/latitude",
      +          "description": "Rounded to 0.1 degrees"
      +        },
      +        "os": {
      +          "$ref": "#/properties/result/properties/data/items/properties/visitorUid"
      +        },
      +        "pageviews": {
      +          "$ref": "#/properties/result/properties/data/items/properties/latitude"
      +        },
      +        "referrer": {
      +          "$ref": "#/properties/result/properties/data/items/properties/visitorUid"
      +        },
      +        "referrerIconUrl": {
      +          "$ref": "#/properties/result/properties/data/items/properties/visitorUid"
      +        },
      +        "referrerSource": {
      +          "$ref": "#/properties/result/properties/data/items/properties/visitorUid"
      +        },
      +        "region": {
      +          "$ref": "#/properties/result/properties/data/items/properties/visitorUid"
      +        },
      +        "sessionStartTime": {
      +          "$ref": "#/properties/result/properties/data/items/properties/visitorUid"
      +        },
      +        "visitorId": {
      +          "description": "Pass to get_visitor",
      +          "type": "string"
      +        },
      +        "visitorUid": {
      +          "type": [
      +            "string",
      +            "null"
      +          ]
      +        }
      +      },
      +      "required": [
      +        "visitorId"
      +      ],
      +      "type": "object"
      +    },
      +    "type": "array"
      +  },
      +  "status": {
      +    "description": "\"success\" on every successful call",
      +    "type": "string"
      +  }
      +}
    • addedOutput schema / properties / result / required
      Added value: +[
      +  "status",
      +  "data"
      +]
    • addedOutput schema / properties / result / type
      Added value: +"object"
    • addedOutput schema / required
      Added value: +[
      +  "result"
      +]
  2. Changed3 schema fields changedv0.1.1
    • changedInput schema / properties / domain / description
      Previous value: -"Website domain to query. Required when using a workspace token unless websiteId is provided."New value: +"Website domain from list_websites (e.g. \"example.com\"). Alternative to websiteId with a workspace token."
    • changedInput schema / properties / websiteId / description
      Previous value: -"Website ID to query. Required when using a workspace token unless domain is provided."New value: +"Website ID from list_websites. Required with a workspace token unless domain is given; ignored with a website key."
    • changedOutput schema / properties / result / description
      Previous value: -"Currently active visitors with their geographic locations."New value: +"Object with status and data: up to 1000 active visitors, each with visitorId, country, countryCode, region, city, latitude, longitude, browser, os, deviceType, currentUrl, referrer, pageviews, totalRevenue, isCustomer, and name/email when identified."
  3. First observedv0.1.0

TDQS

A4.9/5.0
Behavior5/5

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

Annotations already declare readOnly/idempotent/non-destructive, and the description adds genuinely new behavior: coordinates rounded to 0.1 degrees, no IPs or identifying details in the response, and a polling ceiling of once per 5 seconds. It also discloses the auth model (websiteId or domain with a workspace token), which is exactly the operational context annotations cannot convey.

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

Conciseness5/5

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

Five sentences, each carrying distinct information: purpose and window first, then privacy/rounding, then sibling routing, then parameter constraints, then rate limit and auth. Nothing is repeated from the annotations and no sentence is filler.

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?

An output schema exists, so return-value structure need not be explained, and the description still covers the parts the schema cannot: recency window, coordinate precision, PII exclusion, and polling limits. For a read-only live-data tool with three optional parameters, nothing an agent needs to call it correctly is missing.

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

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3; the description earns above that by constraining the parameter space (website selector only, no dates/filters/pagination) and restating the websiteId-or-domain-with-workspace-token requirement as a combined rule. It adds little about individual field syntax beyond what the schema already documents, so it stops short of 5.

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

Purpose5/5

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

States a specific verb and resource (get active visitors), the exact time window (last 5 minutes), the data shape (city-level location for a live map), and scopes it to the user's own website. This is immediately distinguishable from get_realtime, get_cities, and get_countries, which the description names explicitly.

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?

Gives explicit routing rules: use get_realtime when only the count matters, and get_countries or get_cities for geography over a historical range. It also states the negative case (no dates, filters, or pagination), which tells an agent when this tool is not applicable.

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