Skip to main content
Glama

List a course's users

talentlms_list_course_users
Read-only

Users enrolled in a course with their enrollment date, completion status, completion percentage, completion date and total time: the course's progress report. GET /api/v2/courses/{id}/users.

Input Schema

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

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?

readOnlyHint=true already tells the agent this is a safe read, so the bar is lower. The description usefully states what the records contain, but adds nothing about ordering, whether inactive/enrolled-only users are included, or permission requirements — the practical behavioral unknowns for this endpoint.

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?

A single front-loaded sentence that leads with the resource and ends with the endpoint; the field list is dense but earns its place since no output schema exists. Slightly list-heavy but 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?

With no output schema, the description compensates by enumerating the returned fields, and pagination is fully covered by the schema. Remaining gaps (ordering, eligibility of users shown) are minor for a read-only list operation.

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 course_id, page and page_size are already fully documented with defaults and bounds. The description adds no parameter meaning beyond restating the course id in the endpoint path, 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?

Specific verb+resource (users enrolled in a course) plus a precise payload enumeration and the underlying endpoint, which makes it easily separable from siblings like talentlms_list_user_courses or talentlms_list_users. It stops short of naming a sibling explicitly, so 4 rather than 5.

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?

Calling this 'the course's progress report' implies when it is appropriate, but there is no explicit when/when-not guidance and no mention of the nearest overlapping sibling, talentlms_get_course_progress, which an agent could easily pick by mistake.

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.