Skip to main content
Glama

memory_invite_to_room

Generate an invite for a room you own and a ready-to-forward message so others can join by link or code. Default single-use; set max uses or expiry to control access.

Instructions

Mint an invite for a room you own and get a ready-to-forward message. An invite is single-use by default; pass max_uses to let several people join with the same one. The user sends that message to the person they want to add (any messenger); the recipient opens the link or tells THEIR assistant the code to join. Use when the user asks to invite someone to a room they own, including one just created with memory_create_room.

Input Schema

NameRequiredDescriptionDefault
scopeNoRole the invitee gets — 'read' or 'read_write' (default read_write).
room_idYesThe room's id (room_...), from memory_create_room.
max_usesNoHow many people may join with this invite (default 1, single-use).
expires_in_daysNoDays until the invite expires (default 7).

Output Schema

NameRequiredDescriptionDefault
codeNoThe invite code (mnvr_...). Single-use by default, with a configurable use limit. Shown once.
scopeNoRole the invitee will get.
join_urlNoLanding URL the invitee can open to join.
expires_atNoISO 8601 expiry, or null.
room_addressNoThe room's domain address (xroom:<id>).
share_messageYesReady-to-forward invite text.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv0.15.3
    • removedInput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
    • removedOutput schema / $schema
      Removed value: -"http://json-schema.org/draft-07/schema#"
  2. Changed2 schema fields changedv0.11.0
    • changedInput schema / properties / max_uses / maximum
      Previous value: -9007199254740991New value: +1000
    • changedOutput schema / (root)
      Previous value: -nullNew value: +{
      +  "$schema": "http://json-schema.org/draft-07/schema#",
      +  "additionalProperties": false,
      +  "properties": {
      +    "code": {
      +      "description": "The invite code (mnvr_...). Single-use by default, with a configurable use limit. Shown once.",
      +      "type": "string"
      +    },
      +    "expires_at": {
      +      "description": "ISO 8601 expiry, or null.",
      +      "type": [
      +        "string",
      +        "null"
      +      ]
      +    },
      +    "join_url": {
      +      "description": "Landing URL the invitee can open to join.",
      +      "type": "string"
      +    },
      +    "room_address": {
      +      "description": "The room's domain address (xroom:<id>).",
      +      "type": "string"
      +    },
      +    "scope": {
      +      "description": "Role the invitee will get.",
      +      "type": "string"
      +    },
      +    "share_message": {
      +      "description": "Ready-to-forward invite text.",
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "share_message"
      +  ],
      +  "type": "object"
      +}
  3. Changed1 schema field changedv0.10.2
    • addedInput schema / properties / max_uses
      Added value: +{
      +  "description": "How many people may join with this invite (default 1, single-use).",
      +  "maximum": 9007199254740991,
      +  "minimum": 1,
      +  "type": "integer"
      +}
  4. Addedv0.5.0

TDQS

A4.5/5.0
Behavior5/5

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

Annotations only cover the safety flags (non-readonly, non-idempotent, non-destructive). The description adds substantial behavior beyond them: single-use default, max_uses for multi-recipient, the message flow (user forwards, recipient opens link or tells THEIR assistant the code). That workflow context is exactly what annotations cannot convey.

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 tight sentences, front-loaded with the action and artifact. Each sentence carries distinct information (what it mints, the single-use default, the forwarding flow, the trigger) with no filler.

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?

An output schema exists, so return values need no explanation. The description supplies the trigger, defaults, and end-to-end workflow an agent needs; nothing material is missing for correct invocation.

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 all four parameters are already documented with defaults and ranges. The description only reinforces max_uses' single-use default, adding no syntax or format detail beyond the schema. Baseline 3 is appropriate.

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?

States a specific verb+resource ('Mint an invite for a room') and immediately describes the concrete artifact produced (a ready-to-forward message). It is clearly distinguishable from siblings like memory_join_room or memory_create_room.

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?

Explicitly says when to use it: 'when the user asks to invite someone to a room they own, including one just created with memory_create_room,' naming a sibling. It lacks an explicit when-not or an alternative for the recipient side, but the trigger context is unambiguous.

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