Skip to main content
Glama

List groups

list_groups
Read-onlyIdempotent

List all WhatsApp groups the user belongs to. Reads from the cache — no network. For a live snapshot of a single group, use get_group (it forces a fresh GroupMetadata.update).

Examples: All groups: {} Search by group name: { query: "family" } Top 10: { limit: 10 }

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
limitNoMax groups to return (default 50, max 500)
queryNoCase-insensitive substring match against group name

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
resultNoThe JSON-compatible result returned by the Kaption extension

Schema Changelog

Changes observed during successful MCP inspections.

  1. First observed

TDQS

A4.6/5.0
Behavior4/5

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

Annotations already declare the full safety profile (readOnly, idempotent, non-destructive, closed-world). The description adds valuable context beyond that — it reads from cache with no network, and notes get_group forces a fresh GroupMetadata.update, which explains staleness behavior the annotations don't.

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?

Purpose is front-loaded, immediately followed by the cache/no-network caveat and the alternative routing. The examples are compact and each demonstrates a distinct scenario with no filler.

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?

An output schema is present so return values needn't be explained, and annotations cover safety. Combined with cache-vs-live disclosure and param examples, an agent has everything needed to call it correctly; only pagination/ordering of results is left unspecified.

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 description coverage is 100%, so the baseline is 3, but the description goes further by showing each parameter in context (query substring match, limit as top-N). This directly illustrates intended usage of both optional params.

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 ('List') and resource ('WhatsApp groups the user belongs to') with clear scope. It distinguishes itself from the sibling get_group by contrasting list-all behavior against a single-group live lookup.

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?

Explicitly names the alternative (get_group) and the condition that selects it ('For a live snapshot of a single group'). The three examples map concrete intents to inputs, removing ambiguity about when to use which parameter.

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