Skip to main content
Glama

Recipients

get_recipients

List the people in one recipient group, to address a message. Modern students and parents groups include virtual accounts only with include_virtual=true in recipient_type.

Instructions

List the people in one recipient group, to address a message. Modern students and parents groups include virtual accounts only with include_virtual=true in recipient_type. On legacy accounts the lookup changes this login's Librus form state. Nothing is sent.

Tool call template

Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.

{
  "id": 1,
  "jsonrpc": "2.0",
  "method": "tools/call",
  "params": {
    "arguments": {
      "account_alias": "<account_alias>",
      "recipient_type": "<recipient_type>"
    },
    "name": "get_recipients"
  }
}

Input Schema

NameRequiredDescriptionDefault
account_aliasYesLogin alias from list_accounts.
recipient_typeYesA group's reference from get_recipient_types.

Output Schema

NameRequiredDescriptionDefault
itemsYes
backendYes
contextYes
identityYes
paginationNo
observationYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changedv2.8.1
    • changedOutput schema / $defs / Observation / properties / observed_at / pattern
      Previous value: -"^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(?:\\.[0-9]{1,6})?(?:Z|[+-][0-9]{2}:[0-9]{2})?$"New value: +"^[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}(\\.[0-9]{1,6})?(Z|[+-][0-9]{2}:[0-9]{2})?$"
  2. Changed2 schema fields changedv2.5.0
    • removedOutput schema / $defs / Pagination / additionalProperties
      Removed value: -false
    • removedOutput schema / additionalProperties
      Removed value: -false
  3. Changed4 schema fields changedv2.3.1
    • changedInput schema / $defs / RecipientTypeInput / properties / account / pattern
      Previous value: -"^(?:[^\\s\\x00-\\x1f\\x7f]|[^\\s\\x00-\\x1f\\x7f](?:[^\\s\\x00-\\x1f\\x7f]| )*[^\\s\\x00-\\x1f\\x7f])$"New value: +"^[^\\s\\x00-\\x1f\\x7f](?: *[^\\s\\x00-\\x1f\\x7f])*$"
    • addedInput schema / properties / account_alias / description
      Added value: +"Login alias from list_accounts."
    • changedInput schema / properties / account_alias / pattern
      Previous value: -"^(?:[^\\s\\x00-\\x1f\\x7f]|[^\\s\\x00-\\x1f\\x7f](?:[^\\s\\x00-\\x1f\\x7f]| )*[^\\s\\x00-\\x1f\\x7f])$"New value: +"^[^\\s\\x00-\\x1f\\x7f](?: *[^\\s\\x00-\\x1f\\x7f])*$"
    • addedInput schema / properties / recipient_type / description
      Added value: +"A group's reference from get_recipient_types."
  4. First observed

TDQS

A4.4/5.0
Behavior5/5

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

The description discloses the important non-obvious side effect that a legacy lookup changes the login's Librus form state, explaining readOnlyHint=false. It also guarantees that nothing is sent and documents backend-specific virtual-account behavior, all consistently with the supplied 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?

Four short sentences front-load the purpose and then cover the parameter condition, legacy side effect, and non-sending guarantee. Every sentence supplies useful operational information without filler or repetition.

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?

Together with the richly structured input schema and existing output schema, the description supplies the information needed to invoke the lookup safely: input provenance, group scope, virtual-account inclusion, and the legacy state change. No material return-value or safety explanation is missing.

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?

With full schema description coverage, the schema already identifies account_alias and recipient_type and their upstream sources. The description adds meaningful semantics for the nested include_virtual flag in modern student and parent groups, but does not further explain fields such as selection_id or the other components of the recipient reference.

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 opening sentence gives a specific verb, resource, and scope: listing the people in one recipient group for addressing a message. It does not explicitly distinguish this lookup from other recipient- or correspondent-related sibling tools.

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 message-addressing context, single-group scope, and conditional use of include_virtual provide clear invocation guidance, while 'Nothing is sent' rules out using it as a sending operation. It does not name an alternative lookup tool, although the schema usefully points to list_accounts and get_recipient_types for obtaining inputs.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.