Skip to main content
Glama

get_users_stream

Read-only

Retrieve users with cursor-based pagination and filter by tag, email, status, Telegram ID, squad UUID, or traffic limit strategy.

Instructions

Get all users using cursor-based (keyset) pagination with filtering options [READ] GET /api/users/stream

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
tagNoTag to filter users by
sizeNoNumber of results to return, no more than 1000
emailNoEmail to filter users by
cursorNoCursor for pagination — pass the nextCursor from the previous response. Omit on the first request.
statusNoStatus to filter users by
telegramIdNoTelegram ID to filter users by
externalSquadUuidNoExternal squad UUID to filter users by
trafficLimitStrategyNoTraffic limit strategy to filter users by

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observedv1.1.1

TDQS

A3.5/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 keyset-pagination behavior and the read endpoint, but says nothing about ordering stability, rate limits, or how the stream terminates.

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?

One front-loaded sentence with the key method and scope, plus a compact endpoint marker; there is no filler. Every element (verb, resource, pagination model, filters, HTTP note) carries meaning.

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

Completeness3/5

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

There is no output schema, so the description could reasonably say what the response looks like or how to continue pagination, but it only mentions cursor-based pagination and relies on the cursor parameter's schema text. For a list/stream tool with 8 optional filters, that leaves return shape and pagination termination implicit.

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%, so all 8 parameters are already documented, including the cursor semantics ('pass the nextCursor from the previous response'). The description only adds a generic 'filtering options' phrase and no parameter-level meaning beyond the schema, which is the expected baseline.

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 ('Get') and resource ('all users') plus the distinguishing mechanism ('cursor-based (keyset) pagination with filtering options'). An agent can infer this is the paginated/streaming variant, but the description never names or contrasts with the sibling get_users, leaving that differentiation implicit.

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

Usage Guidelines3/5

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

The phrase 'cursor-based (keyset) pagination' implies this is for large or streaming result sets, but there is no explicit when-to-use, when-not-to-use, or alternative (e.g., get_users) guidance. Usage is only indirectly signaled by the pagination style.

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