Skip to main content
Glama
Sign In

whatsmcp

by com.whatsmcp
OverviewDiscussionsAdmin

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
    • changedOutput schema / properties / refusal / properties / account_status / description
      Previous value: -"when the number is not working: its status — starting, not_running, whatsapp_down, suspended, pairing, unlinked or locked"New value: +"when the number is not working: its status — starting, not_running, whatsapp_down (telegram_down for a Telegram account), suspended, pairing, unlinked or locked"
  2. 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"
+  ]
+}
  3. 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"
+}
  4. First observed

TDQS

A4.2/5.0
Behavior4/5

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

Adds real behavioral context beyond the annotations: the admin permission requirement and the consequence of reset=true (revocation plus reissue). One tension is left unaddressed — revoking an existing link invalidates it for everyone who holds it, yet destructiveHint is false; the description could have clarified that this is a link rotation rather than data loss.

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 waste, with the primary read operation front-loaded and the mutating variant plus prerequisite following. Nothing is repeated or padded.

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?

An output schema exists, so return values need no explanation, and the admin prerequisite plus reset behavior cover the main invocation risks. Minor gaps remain, such as what happens when the caller is not an admin or when the group has no link yet.

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%, so group_jid, account_id, and reset are already fully documented, including the cross-references to wa_list_groups and wa_list_accounts. The description restates the reset semantics without adding format or edge-case detail, 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 immediately covers the mutation variant via reset=true. It is clearly distinguishable from neighbors like wa_update_group, wa_list_groups, and wa_create_group.

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?

Gives a concrete condition for the alternative mode ('set reset=true to revoke it and issue a new one') and a hard prerequisite ('must be a group admin'). It does not name a sibling tool as an alternative, but no sibling overlaps enough to require routing guidance.

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

All whatsmcp toolsInspect
Try in Browser
One endpoint for every MCP toolRayrun runs every MCP server behind one URL and holds the credentials. Each call is decided per client, tool, and argument, then recorded.ray.runAd

Glama MCP Gateway

Add one secure layer between your agents and this server.

Resources