Skip to main content
Glama

get_user_group

Read-onlyIdempotent

Fetch a user group's details by its unique ID from LearnWorlds. Read-only lookup returns the group data, ideal for reporting and verification without modifying the school.

Instructions

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

Get a user group. Returns the user group specified by the provided user group id.

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. 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, deletes_user_group, get_users_user_group, remove_user_user_group, update_user_group.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesThe unique identifier of the user group

Schema Changelog

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

  1. First observedv1.0.0

TDQS

A4.5/5.0
Behavior5/5

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

Beyond the annotations, the description adds valuable behavioral context: it is a read-only lookup that creates/changes/deletes nothing, auth is injected server-side, calls are throttled and retried, and non-2xx responses surface as errors with specific status meanings. This goes well beyond the readOnlyHint and idempotentHint annotations.

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: purpose, behavior, returns, use-when, and related tools. Every sentence adds information, and the core purpose is front-loaded before the supporting detail. The length is justified by the absence of an output schema.

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 one-parameter read-only lookup with no output schema, the description is complete: it explains what the tool returns, how errors are presented, what the auth/rate-limit behavior is, and which sibling tools are related. An agent has enough context to select and invoke the tool correctly.

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 is 100%: the single required parameter 'id' is already described as 'The unique identifier of the user group' in the input schema. The description merely restates that concept ('provided user group id') and adds no new format, source, or validation detail, so the schema carries the semantic load.

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 a clear verb and resource: 'Get a user group' and specifies it returns the user group identified by the provided id. The singular-by-id framing distinguishes it from the plural listing tool get_user_groups and other related user-group tools, so an agent can tell what this tool does.

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?

The description explicitly says when to use it ('safe to call speculatively for lookups and reporting') and when not to ('Not for changing anything โ€” use the matching ๐ŸŸก write tool'), and it lists related user-group tools. However, it does not explicitly contrast this read tool with the other read-oriented siblings like get_user_groups or get_users_user_group, leaving the choice among those partially implicit.

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