Skip to main content
Glama

Add Recipients

add_recipients
Destructive

Add people to an existing Canvas Inbox conversation so they receive its messages. Preview the recipients, then confirm to complete the addition after user approval.

Instructions

Add more people to an existing Inbox conversation so they receive its messages. Get user IDs from find_recipients. [NEEDS CONFIRMATION: call it once for a preview and a confirm_token, show the preview to the user, and only if they say yes call it again with the same arguments, confirm=true and that confirm_token. Apps that can ask the user directly show a confirmation instead.]

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": {
      "conversation_id": "<conversation_id>",
      "recipients": "<recipients>"
    },
    "name": "add_recipients"
  }
}

Input Schema

NameRequiredDescriptionDefault
confirmNoSet to true together with confirm_token to carry out a request you already previewed.
recipientsYesUser IDs to add, from find_recipients.
confirm_tokenNoThe one-time token from the preview. Only use it after the user has said yes.
conversation_idYesInbox conversation ID (numeric string). Get it from list_conversations.

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changedv1.3.0
    • changedInput schema / properties / confirm / description
      Previous value: -"Must be true to actually execute. Omit or set false to get a dry-run preview first."New value: +"Set to true together with confirm_token to carry out a request you already previewed."
    • addedInput schema / properties / confirm_token
      Added value: +{
      +  "description": "The one-time token from the preview. Only use it after the user has said yes.",
      +  "type": "string"
      +}
  2. Changed2 schema fields changedv1.0.2
    • changedInput schema / properties / conversation_id / description
      Previous value: -"Canvas ID (numeric string)"New value: +"Inbox conversation ID (numeric string). Get it from list_conversations."
    • addedInput schema / properties / recipients / description
      Added value: +"User IDs to add, from find_recipients."
  3. First observedv1.0.1

TDQS

A4.2/5.0
Behavior4/5

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

Annotations already flag destructiveHint=true, openWorldHint=true and non-idempotence, but the description adds the critical behavior they do not convey: a mandatory two-phase preview/confirm flow with a one-time confirm_token tied to identical arguments. It also hints at the real-world consequence that added people start receiving the conversation's messages. It does not say what happens to prior message visibility for new recipients, which keeps it from a 5.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness3/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The first two sentences are tight and front-loaded, but the bracketed block is long and carries an internal editorial marker ('[NEEDS CONFIRMATION: ...]'). The closing clause about apps that can ask the user directly is vaguely worded and leaves ambiguity about whether the preview step still applies.

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?

For a mutating four-parameter tool with full schema coverage and no output schema, the definition covers prerequisites, the required confirmation flow, and the user-visible effect. Residual gaps are whether added recipients gain access to conversation history and what the preview response contains.

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 description coverage is 100%, so the schema already defines all four parameters; the description still adds meaning by explaining that confirm and confirm_token must be used together on the second call and by pointing at find_recipients as the source of recipient IDs. That is real value beyond the schema, not repetition.

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 specific verb and resource ('Add more people to an existing Inbox conversation') and states the effect ('so they receive its messages'). It is clearly distinguishable from the sibling find_recipients, which is identified as the source of the IDs rather than the same operation.

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 clear procedural guidance: fetch IDs from find_recipients, then run a preview call, then repeat with confirm=true and the token only after the user approves. What is missing is an explicit exclusion clause (e.g. when to use send_message or create a new conversation instead of adding recipients).

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

Deploy Server

Other Tools