Skip to main content
Glama

List my guests

list_my_guests
Read-onlyIdempotent

List the guests of the current user: the people they invite to play with an access code, without an Educaplay account. Each guest brings its id, name, access code and link, its groups, and the games and lists it can open. Use the ids with set_folder_guest_access. Same as GET users/{idUser}/guests/ of the Educaplay REST API, for the current user: its JSON body, or its error body, comes in "response". While "hasMore" is true, pass "nextCursor" as "before" to get the next page.

Tool call template

This tool declares no required parameters. Add optional parameters from the input schema as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {},
    "name": "list_my_guests"
  }
}

Input Schema

NameRequiredDescriptionDefault
q2NoOnly the guests whose name or access code contains this text.
groupNoOnly the guests of this group, by its id from list_my_guest_groups, or "none" for the guests without a group.
beforeNo"nextCursor" of the previous page. Omit it for the first page.
knownOnlyNotrue to leave out the guests that still have the automatic name; "hiddenCount" says how many were left out.
connectedFirstNotrue to list first the guests who have already entered with their code.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Added

TDQS

A4.3/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive and closed-world, so the safety profile is covered. The description adds genuine behavior beyond that: the response envelope ("its JSON body, or its error body, comes in 'response'") and the exact pagination loop (while "hasMore" is true, pass "nextCursor" as "before"). It stops short of noting ordering guarantees or performance notes.

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?

Three sentences, front-loaded with purpose, then the id hand-off, then response/pagination. The "Same as GET users/{idUser}/guests/ of the Educaplay REST API" clause is slightly verbose but useful for API-literate agents; nothing is redundant with the title.

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 takes on explaining the return payload and error handling, and it does so along with the pagination contract. One minor gap remains: it does not explain how "hiddenCount" interacts with the response when knownOnly is used, though the schema covers that parameter.

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?

Schema coverage is 100%, so the baseline would be 3, but the description adds meaning the schema cannot: the relationship between the non-parameter "hasMore" flag and the "nextCursor"/"before" cycle, plus the purpose of guest ids for set_folder_guest_access. The filter parameters themselves are only echoed, not enriched.

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?

Specific verb and resource ("List the guests of the current user") plus a definition of what a guest is ("people they invite to play with an access code, without an Educaplay account") and an enumeration of the returned fields. It is clearly distinct from the sibling list_my_guest_groups, which lists groups rather than guests.

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?

It gives a concrete downstream usage rule ("Use the ids with set_folder_guest_access") and implies the context in which to call it. It does not state exclusions or explicitly contrast with list_my_guest_groups for an agent unsure which of the two to call.

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.

Resources