Skip to main content
Glama

List users

talentlms_list_users
Read-only

List the portal's users (id, login, name, email, user type, status, registration, last login), paginated. Filter by keyword (name/login/email), exact email or login, status, branch, group, last-updated range or a custom field value. GET /api/v2/users.

Input Schema

NameRequiredDescriptionDefault
pageNoPage number (default 1).
emailNoExact email address.
loginNoExact username (login).
statusNoOnly active or inactive users.
keywordNoSearch across name, surname, login and email.
group_idNoOnly users in this group.
branch_idNoOnly users in this branch.
page_sizeNoItems per page, 1-100 (TalentLMS default 10).
updated_toNoUsers updated on or before this ISO 8601 date-time.
updated_fromNoUsers updated on or after this ISO 8601 date-time, e.g. 2025-01-01T00:00:00.
custom_field_valueNoUsers with this value in one of their custom user fields.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

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 the description is consistent with a read-only GET. It adds that results are paginated and names the endpoint, but says nothing about total counts, default page size behavior, or ordering — modest added value over annotations.

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?

Two front-loaded sentences: the returns paragraph first, then the filtering capabilities. Dense and low-waste; the trailing endpoint is a small but justifiable addition.

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 11 optional parameters and no output schema, the description usefully compensates by enumerating the returned user fields, which is otherwise unavailable. Missing only behavioral detail such as ordering and whether pagination metadata is returned, so it falls short of fully complete.

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 every one of the 11 parameters is already documented in the schema. The description merely summarizes the filter set without adding syntax, precedence, or combination rules (e.g. whether keyword and email can be combined), so the baseline 3 applies.

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 and resource ('List the portal's users') and even enumerates the fields returned plus the backing endpoint (GET /api/v2/users). It is clear what the tool does, but it never distinguishes itself from closely related siblings like talentlms_list_branch_users or talentlms_list_group_users, which overlap in scope.

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 filter inventory (keyword, email, login, status, branch, group, updated range, custom field) implies when the tool is useful, but there is no explicit when-to-use or when-not-to-use guidance, nor any pointer to the branch/group-scoped list siblings as alternatives.

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.