Skip to main content
Glama

WhatsMCP: MCP for WhatsApp

Get Group Invite Link

wa_get_group_invite_link

Get a WhatsApp group's invite link, or set reset=true to revoke it and issue a new one. The account must be a group admin.

Input Schema

NameRequiredDescriptionDefault
resetNotrue to revoke the current link and issue a new one
group_jidYesthe group (…@g.us) JID, as returned by wa_list_groups
account_idYesthe account, as returned by wa_list_accounts

Output Schema

NameRequiredDescriptionDefault
itemsNothe rows of a list operation
statusYesok (the operation succeeded) or refused (see refusal; for wa_update_group, applied lists the changes that took effect before it)
appliedNowa_update_group only: the settings that were changed, in order — on a refusal, the ones that took effect before it
refusalNopresent only when status is refused
summaryNoa human-readable result
group_jidNothe new group's JID (wa_create_group only) — use it as wa_send_message's 'to'
invite_linkNothe group's invite link (wa_create_group or wa_get_group_invite_link)

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • addedOutput schema / properties / refusal / properties / candidates
      Added value: +{
      +  "description": "on an account_ambiguous refusal: the accounts to choose from — retry with one of these as account_id",
      +  "items": {
      +    "additionalProperties": false,
      +    "properties": {
      +      "account_id": {
      +        "description": "the id to retry with as account_id",
      +        "type": "string"
      +      },
      +      "name": {
      +        "description": "the account's WhatsApp display name",
      +        "type": "string"
      +      },
      +      "phone": {
      +        "description": "the account's phone number, E.164",
      +        "type": "string"
      +      },
      +      "status": {
      +        "description": "whether the number works right now — live, connecting, or why not, as wa_list_accounts reports it",
      +        "type": "string"
      +      }
      +    },
      +    "required": [
      +      "account_id"
      +    ],
      +    "type": "object"
      +  },
      +  "type": [
      +    "null",
      +    "array"
      +  ]
      +}
  2. Changed3 schema fields changed
    • addedOutput schema / properties / refusal / properties / account_status
      Added value: +{
      +  "description": "when the number is not working: its status — starting, not_running, whatsapp_down, suspended, pairing, unlinked or locked",
      +  "type": "string"
      +}
    • addedOutput schema / properties / refusal / properties / account_status_reason
      Added value: +{
      +  "description": "the detail of account_status, e.g. no_egress, stopped, no_plan",
      +  "type": "string"
      +}
    • addedOutput schema / properties / refusal / properties / since
      Added value: +{
      +  "description": "when the number stopped working, RFC3339, when known",
      +  "type": "string"
      +}
  3. Changed2 schema fields changed
    • addedOutput schema / properties / applied
      Added value: +{
      +  "description": "wa_update_group only: the settings that were changed, in order — on a refusal, the ones that took effect before it",
      +  "items": {
      +    "type": "string"
      +  },
      +  "type": [
      +    "null",
      +    "array"
      +  ]
      +}
    • changedOutput schema / properties / status / description
      Previous value: -"ok (the operation succeeded) or refused (nothing was done)"New value: +"ok (the operation succeeded) or refused (see refusal; for wa_update_group, applied lists the changes that took effect before it)"
  4. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Annotations declare readOnlyHint=false, idempotentHint=false and destructiveHint=false; the description usefully adds that reset=true revokes the existing link and that admin rights are required — the two facts an agent most needs before calling. It does not flag that revocation is irreversible for existing members or what error appears for non-admins, so it improves on annotations without fully covering them.

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?

Two sentences, zero filler, with the primary action first and the destructive variant second. The admin prerequisite is appended where it is cheap to read.

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 a full input schema, an output schema and annotations present, the description only needs to carry prerequisites and mode behavior, which it does. Minor gaps remain on failure behavior for non-admins and whether the old link dies immediately after reset.

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%, with per-parameter descriptions already explaining reset, group_jid (…@g.us from wa_list_groups) and account_id (from wa_list_accounts). The description's mention of reset adds no semantics beyond the schema text, so the baseline 3 applies.

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 and resource (get a WhatsApp group's invite link) and explicitly covers the two modes: plain retrieval versus reset=true revocation plus reissue. No sibling tool touches invite links, so the agent can distinguish it immediately.

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?

'set reset=true to revoke it and issue a new one' gives a clear condition for the non-default mode, and 'The account must be a group admin' states a prerequisite. It stops short of naming exclusions or what to do on failure, keeping it at a strong 4 rather than a full when/when-not treatment.

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