Skip to main content
Glama

get_users

Read-onlyIdempotent

Retrieve paginated lists of school users, filtered by role, status, tags, custom fields, or registration dates. Use for read-only reporting and lookups without modifying data.

Instructions

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

Get all users. Returns a list with all the users of the school. The users are in sorted order, with the most recently created user appearing first, and the list is paginated, with a default limit of 20 users per page. To refine the list of users, there are a number of query params outlined in the following section; In case more than one Query param is provided, then all of them will be applied (AND operator).

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 and size each page with items_per_page; cf__field_name reaches LearnWorlds under the original spec name. 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 Users tools: create_user, enroll_user_product, get_courses_enrollments_user, get_products_user, get_seat_offerings_that_user_is_member.

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
roleNoFilter by user role
tagsNoFilter by tags. For several tag values, a comma separated string can be provided.
statusNoFilter by user status
cf__field_nameNoFilter by custom field. All custom fields start with the cf_ prefix; the "$field_name" part should be replaced by the name of the corresponding custom field. Also, it is possible to use more than one custom fields as filters, using the aforementioned convention. Sent to LearnWorlds as "cf_$field_name".
items_per_pageNoFilter by the items per page number
include_suspendedNoFilter by include_suspended flag. The default value is false.
registration_afterNoFilter by registration after the given datetime (expected in UNIX timestamp format)
registration_beforeNoFilter by registration before the given datetime (expected in UNIX timestamp format)

Schema Changelog

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

  1. Changed2 schema fields changedv1.0.1
    • removedInput schema / properties / cf_$field_name
      Removed value: -{
      -  "description": "Filter by custom field. All custom fields start with the cf_ prefix; the \"$field_name\" part should be replaced by the name of the corresponding custom field. Also, it is possible to use more than one custom fields as filters, using the aforementioned convention.",
      -  "example": "testvalue",
      -  "type": "string"
      -}
    • addedInput schema / properties / cf__field_name
      Added value: +{
      +  "description": "Filter by custom field. All custom fields start with the cf_ prefix; the \"$field_name\" part should be replaced by the name of the corresponding custom field. Also, it is possible to use more than one custom fields as filters, using the aforementioned convention. Sent to LearnWorlds as \"cf_$field_name\".",
      +  "example": "testvalue",
      +  "type": "string"
      +}
  2. First observedv1.0.0

TDQS

A4.9/5.0
Behavior5/5

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

Beyond annotations that already declare readOnly, idempotent, and non-destructive, the description adds concrete behavior: server-side auth injection, throttling and retry handling, sorted and paginated results, AND semantics for multiple filters, and detailed error response behavior. This is substantial added transparency.

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?

The description is well-structured with labeled sections: Behavior, Parameters, Returns, Use when. It is longer than minimal, but every section carries distinct operational information needed for safe invocation, and the key purpose and constraints are front-loaded.

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?

For a tool with no output schema and nine optional parameters, the description fully covers the essential context: what it returns, how pagination works, how filters behave, authentication, error handling, and when to use it. The parameter schema covers the rest.

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?

The schema already covers 100% of parameters, so the baseline is 3. The description adds valuable usage semantics: how to walk pages with `page` and `items_per_page`, how `cf__field_name` is translated to the original LearnWorlds parameter name, and that multiple filters combine with AND. This goes beyond the schema.

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 opens with 'Get all users' and clearly identifies the resource and scope: a list of all school users, sorted with newest first. It differentiates from siblings by naming related Users tools and specifying this is the read-only list endpoint.

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?

Explicit 'Use when' guidance states it is safe for speculative lookups and reporting, and explicitly says not to use it for changes, directing to the matching write tool. It also lists related Users tools, giving clear context for choosing this tool over alternatives.

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