Skip to main content
Glama

get_user_groups

Read-onlyIdempotent

Retrieve all user groups from your LearnWorlds school in paginated lists, newest first. Use this read-only lookup for reports and checks without modifying any data.

Instructions

๐ŸŸข READ-ONLY ยท GET /v2/user_groups

Get all user groups. Returns a list of all user groups of the school. The user groups are in sorted order, with the most recently created appearing first and the list is paginated, with a default limit of 20 users per page.

Behavior: read-only lookup against the live school; creates, changes and deletes nothing. Auth (admin API token + Lw-Client id) is injected server-side, never by the model; calls are throttled to stay under LearnWorlds' 30-per-10s cap and retried on 429/5xx. Parameters: results are paged โ€” walk them with page. Returns: HTTP <status> followed by the LearnWorlds JSON response body. A non-2xx reply surfaces as a tool error with that status and the API error payload โ€” 401 bad/expired token, 403 not permitted, 404 no such record, 422 rejected input. Use when: safe to call speculatively for lookups and reporting. Not for changing anything โ€” use the matching ๐ŸŸก write tool. Related User groups tools: add_user_user_group, create_user_group, deletes_user_group, get_user_group, get_users_user_group.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pageNoFilter by the page number. In case page number is higher than the maximum one, the results of last page will be returned

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. First observedv1.0.0

TDQS

A4.4/5.0
Behavior5/5

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

Goes well beyond the annotations by disclosing auth injection, rate limiting (LearnWorlds 30-per-10s cap), retry behavior on 429/5xx, and the error payload structure for non-2xx responses. This gives the agent a realistic picture of side effects and failure modes, with no contradiction to readOnlyHint/idempotentHint/destructiveHint.

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?

The description is longer than strictly necessary but well-structured with labeled sections (Behavior, Parameters, Returns, Use when). It front-loads the core purpose and every section adds useful information, though some redundancy with annotations exists.

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?

Despite no output schema, the description covers return format, pagination semantics, error handling, auth, and rate limiting. It also points to related tools, making it complete for an agent to select and invoke this tool appropriately.

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 coverage for the single parameter is 100%, and the description merely reinforces pagination with 'walk them with page.' It adds some intent context but does not materially enrich the schema's description of the page parameter.

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?

The description clearly states the tool 'Gets all user groups' and specifies it returns a list of all user groups of the school, with sorting and pagination details. This unambiguous verb+resource statement distinguishes it from singular 'get_user_group' and other sibling tools.

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?

Provides explicit guidance: 'safe to call speculatively for lookups and reporting' and 'Not for changing anything โ€” use the matching ๐ŸŸก write tool.' It also lists related user group tools, but does not explicitly contrast when to prefer this list tool over get_user_group or get_users_user_group beyond the plural/scope distinction.

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

Install Server

Other Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/ohneben/Learnworlds-MCP'

If you have feedback or need assistance with the MCP directory API, please join our Discord server