whatsmcp

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

TableJSON Schema

Name	Required	Description
`reset`	No	true to revoke the current link and issue a new one
`group_jid`	Yes	the group (…@g.us) JID, as returned by wa_list_groups
`account_id`	Yes	the account, as returned by wa_list_accounts

Output Schema

TableJSON Schema

Name	Required	Description
`items`	No	the rows of a list operation
`status`	Yes	ok (the operation succeeded) or refused (see refusal; for wa_update_group, applied lists the changes that took effect before it)
`applied`	No	wa_update_group only: the settings that were changed, in order — on a refusal, the ones that took effect before it
`refusal`	No	present only when status is refused
`summary`	No	a human-readable result
`group_jid`	No	the new group's JID (wa_create_group only) — use it as wa_send_message's 'to'
`invite_link`	No	the group's invite link (wa_create_group or wa_get_group_invite_link)

Schema Changelog

Changes observed during successful MCP inspections.

Changed3 schema fields changedOct 14, 2026

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"
+}

First observedSep 27, 2026

TDQS

A4.3/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, so the mutation profile is already conveyed. The description adds genuinely new behavioral context: the admin authorization requirement and the side effect that reset revokes the existing link before issuing a replacement, which is more specific than the schema's one-line reset note.

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 tight sentences, zero waste. The primary read behavior is front-loaded and the optional destructive branch plus its prerequisite follow immediately.

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. With the read/reset branches, the admin prerequisite and full schema coverage, an agent has everything needed to invoke this tool correctly.

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% and the schema already explains reset, group_jid and account_id, including where the JIDs come from. The description only restates reset's effect, adding no syntax, format or default information beyond the schema, 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 additionally covers the alternate reset behavior in the same sentence. An agent immediately knows this tool reads an invite link and can optionally rotate it, distinct from siblings like wa_update_group or wa_join_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 clear precondition ('The account must be a group admin') and explains the branch condition for reset=true. It does not name an alternative tool or state when not to use it, but the context is unambiguous for this narrow operation.

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

All whatsmcp tools Inspect

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

Need Help?