Skip to main content
Glama

List a flow's sessions

list_whatsapp_flow_sessions
Read-onlyIdempotent

List a flow's sessions. The contacts a flow was sent to, newest first. By default only completed sessions — the submissions — dated by when they were submitted; any other status is dated by when the flow was sent. Test sends from the flow editor are left out unless include_test=true. The list carries no answers. Add include=answers to export them: the real values, sensitive ones included, exactly as the conversation's Reveal answers shows them. Every session revealed this way is recorded in the account's audit log under the calling user, so page through only what you need. Answers are removed after the account's retention window; such a session comes back with answers_purged: true. Administrators only. Requires feature: whatsapp_flows.

Input Schema

NameRequiredDescriptionDefault
pageNoPage number, from 1.
sinceNoSessions submitted (for `completed`) or sent (otherwise) at or after this moment — an ISO 8601 timestamp, or a date (`YYYY-MM-DD`) for the start of that day.
untilNoSame, at or before this moment; a date means the end of that day.
fieldsNoOptional: return only these fields of each record.
statusNoOne session status.completed
includeNo`answers` to add each session's submitted answers (audited).
per_pageNoSessions per page. Values above 100 are treated as 100.
include_testNoInclude sends to test numbers.
whatsapp_flow_idYesID of the flow

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.5/5.0
Behavior5/5

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

Adds substantial context beyond the annotations: revealed answers are written to the account audit log under the calling user, answers are purged after a retention window and surface as answers_purged: true, and non-completed statuses are dated by send time while completed ones use submission time. The admin-only and feature-flag constraints are also disclosed.

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 purpose and default scope, then layers defaults, exclusions, auditing, retention and permissions with no filler sentences. It is dense and long, but each clause carries decision-relevant information for a 9-parameter tool.

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?

With no output schema, the description does the heavy lifting on return semantics: it states the list carries no answers by default, what include=answers adds, and the answers_purged marker. It stops short of describing the response envelope or pagination metadata, leaving a small gap.

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 already 100%, so the baseline is 3, but the description earns more by explaining non-obvious semantics the schema omits: the status-dependent meaning of since/until, that include=answers exports sensitive real values as the conversation's Reveal answers shows them, and that answers may be purged. Minor parameters like page/fields get no extra narrative.

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 ('List a flow's sessions') and immediately defines what a session is ('the contacts a flow was sent to, newest first'), which separates it from list_whatsapp_flows and get_whatsapp_flow. The scope defaults (completed only, test sends excluded) further pin down what this tool returns.

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

Usage Guidelines4/5

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

Gives concrete operating conditions: default status is completed, test sends are omitted unless include_test=true, answers require include=answers, and the tool is admin-only with a whatsapp_flows feature requirement. It even advises paging conservatively due to auditing. It does not explicitly compare against sibling tools, so it stops short of a 5.

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