Skip to main content
Glama

getPastClientNum

Read-only

Retrieve historical client count trends over a Unix epoch time range, optionally for a specific site, to track how connected device numbers changed.

Instructions

Get historical client count trend over a time range. Returns a time-series of client counts to show how connected devices changed over the specified period. Requires start and end as Unix epoch seconds.

Input Schema

NameRequiredDescriptionDefault
endYesEnd of the time range as Unix epoch seconds.
startYesStart of the time range as Unix epoch seconds.
siteIdNoSite ID to target. If omitted, uses the default site from OMADA_SITE_ID config. Use listSites to discover available site IDs.

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv0.19.0-rc.1

TDQS

B3.2/5.0
Behavior3/5

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

Annotations already declare readOnlyHint=true and destructiveHint=false, so the safety profile is covered. The description adds the useful behavioral fact that the result is a time-series rather than a scalar snapshot, but it says nothing about granularity, bucketing, aggregation, latency, or whether large ranges are truncated.

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?

Three sentences, front-loaded with the core purpose. There is mild redundancy between "over a time range" and "over the specified period" plus a restatement of the epoch-second format, but nothing that obscures the intent.

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

Completeness4/5

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

For a three-parameter read tool with no output schema, the description covers what is returned (a time-series of client counts) and the required inputs, which is enough to call it correctly. Only the resolution/aggregation semantics of the series are left unstated.

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?

Schema description coverage is 100%, including the siteId fallback to OMADA_SITE_ID and the listSites discovery hint, so the schema carries parameter meaning fully. The description only restates that start and end are Unix epoch seconds, adding no semantics beyond the schema.

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?

The description uses a specific verb+resource ("Get historical client count trend") and states the unit of return (a time-series of connected-device counts), so an agent knows exactly what it retrieves. It does not, however, distinguish itself from plausible siblings such as getGridClientHistory, getClientsDistribution, or listClientsPastConnections, which a reader would have to open to disambiguate.

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

Usage Guidelines2/5

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

There is no explicit when-to-use guidance beyond the trivial requirement of a time range, and no mention of which sibling to prefer for a different client-count view. The only conditional information presented (start/end required, epoch seconds) is already in the schema.

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

Deploy Server

Other Tools