Skip to main content
Glama

List a branch's users

talentlms_list_branch_users
Read-only

Users in a branch (id, login, name, email, user type, status, last login), paginated. GET /api/v2/branches/{id}/users.

Input Schema

NameRequiredDescriptionDefault
pageNoPage number (default 1).
branch_idYesThe branch id (a positive integer).
page_sizeNoItems per page, 1-100 (TalentLMS default 10).

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

B3.4/5.0
Behavior3/5

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

readOnlyHint=true already establishes this as a safe read. The description adds useful context by listing returned fields and the paginated nature of the response, but says nothing about rate limits, ordering, or what an empty branch returns.

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?

A single compact sentence that front-loads the resource and field list, then the endpoint. Nothing is padded or redundant.

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 compensates by enumerating the returned fields, and pagination params are fully covered by the schema. Only the absence of result ordering and edge-case behavior keeps it from a 5.

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%, with page, branch_id and page_size all documented including the 1-100 bound and default page size. The description only adds the word 'paginated', so 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?

The description names the resource (users of a specific branch) and enumerates the returned fields, plus the underlying endpoint. Branch scoping implicitly differentiates it from list_users, list_group_users and list_course_users, though siblings are never named explicitly.

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

Usage Guidelines2/5

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

No statement of when to use this versus talentlms_list_users, talentlms_list_user_branches or talentlms_list_group_users. The only guidance is the implicit scoping in the phrase 'Users in a branch'.

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.