Skip to main content
Glama
flowsery

flowsery

Official

Get Active Visitor Count

get_realtime
Read-onlyIdempotent

Count visitors active on a site in the last 5 minutes as a point-in-time number. Use it for current traffic snapshots; returns data[0].visitors without history or filters.

Instructions

Count the visitors active on the site within the last 5 minutes. A point-in-time number with no history: it takes no date, filter, or pagination arguments. Use get_timeseries with interval hour for recent trends and get_realtime_map when you need where those visitors are. Returns data[0].visitors. 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"
  }
}

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: data[0].visitors is the count of visitors active in the last 5 minutes."
    • addedOutput schema / properties / result / properties
      Added value: +{
      +  "data": {
      +    "description": "One row; visitors is the count active in the last 5 minutes",
      +    "items": {
      +      "additionalProperties": true,
      +      "properties": {
      +        "visitors": {
      +          "type": "number"
      +        }
      +      },
      +      "required": [
      +        "visitors"
      +      ],
      +      "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: -"Count of visitors active on the site within the last 5 minutes."New value: +"Object with status and data: data[0].visitors is the count of visitors active in the last 5 minutes."
  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, closed-world, but the description adds behavior they don't cover: point-in-time with no history, no date/filter/pagination arguments, a polling rate limit, and the auth requirement (websiteId or domain with a workspace token). That is meaningful context beyond the structured fields.

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?

Four short sentences, front-loaded with what the tool returns and when to reach for a sibling instead. The only mildly redundant element is "Returns data[0].visitors," which the output schema already covers, but it costs almost nothing.

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 zero-required-parameter read tool with full annotations, 100% schema coverage, and an output schema, this is complete: purpose, alternatives, auth prerequisites, rate limit, and response location are all covered. Nothing an agent needs in order 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 still adds value by stating the tool takes no date, filter, or pagination arguments and by restating the websiteId-or-domain plus workspace-token requirement. It does not clarify the workspace-key vs workspace-token distinction further, which would have pushed it to a 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 ("Count the visitors active on the site") plus a precise scope ("within the last 5 minutes"). It explicitly distinguishes itself from get_timeseries and get_realtime_map, so an agent can select it without opening any schema.

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 alternatives with the condition that selects each: get_timeseries with interval hour for trends, get_realtime_map for location. It also adds a usage constraint (poll no more than once every 5 seconds) and states what the tool deliberately does not accept.

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