whatsmcp

Check Pairing Status

wa_pair_status

Read-only

Check a pairing started with wa_pair_account. While state is "qr" a new image is returned each time — show the latest to the user. While state is "code", show pair_code. A Telegram pairing may report "password_needed": the user enters their cloud password on the console's pairing page, never here. When state becomes "paired" the account is ready and appears in wa_list_accounts.

Input Schema

Name	Required	Description	Default
`pair_id`	Yes	the pair_id returned by wa_pair_account

Output Schema

Name	Required	Description
`state`	Yes	starting, qr, code, password_needed (a Telegram account with two-step verification: the user must enter their cloud password on the console's pairing page — never ask for it here), paired or failed
`network`	No	the messaging network the pairing links on: whatsapp or telegram
`pair_id`	No	pass this to wa_pair_status to follow the pairing
`refusal`	No	present only when pairing could not be started
`pair_code`	No	the 8-character code the user types on their phone (phone-number pairing only)
`expires_at`	No	when pair_code stops working, RFC 3339 (phone-number pairing only)
`needs_plan`	No	true when the linked number has no plan yet and will not run until the user buys one in the console
`instructions`	No	what to tell the user to do
`qr_png_base64`	No	a PNG image of the QR code, base64 encoded — display this to the user

Schema Changelog

Changes observed during successful MCP inspections.

Changed1 schema field changedNov 2, 2026

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"

Changed1 schema field changedOct 26, 2026

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

Changed2 schema fields changedOct 26, 2026

addedOutput schema / properties / network

Added value: +{
+  "description": "the messaging network the pairing links on: whatsapp or telegram",
+  "type": "string"
+}

changedOutput schema / properties / state / description

Previous value: -"starting, qr, code, paired or failed"New value: +"starting, qr, code, password_needed (a Telegram account with two-step verification: the user must enter their cloud password on the console's pairing page — never ask for it here), paired or failed"

Changed6 schema fields changedOct 14, 2026

addedOutput schema / properties / expires_at

Added value: +{
+  "description": "when pair_code stops working, RFC 3339 (phone-number pairing only)",
+  "type": "string"
+}

addedOutput schema / properties / pair_code

Added value: +{
+  "description": "the 8-character code the user types on their phone (phone-number pairing only)",
+  "type": "string"
+}

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

changedOutput schema / properties / state / description

Previous value: -"starting, qr, paired or failed"New value: +"starting, qr, code, paired or failed"

First observedSep 27, 2026

TDQS

A4.7/5.0

Behavior5/5

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

Annotations declare readOnlyHint=true and idempotentHint=false; the description explains why the latter holds (a new image is returned each time while in "qr"), which is exactly the context annotations cannot convey. It further discloses the password_needed branch and the state transition to "paired", giving real behavioral guidance beyond the flags.

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 short sentences, each mapped to a distinct state or action, with the primary instruction (check the pairing) front-loaded. No redundant restatement of the title or schema.

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?

Output schema exists so return values need not be re-explained, yet the description still enumerates every state the caller must handle and the correct user-facing action for each. Nothing an agent needs to poll correctly and act on the result is missing.

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?

The single pair_id parameter is fully documented in the schema (100% coverage) as "the pair_id returned by wa_pair_account", and the description merely references the same origin. No additional format, lifetime, or reuse semantics are added, so the schema does the work and 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?

Specific verb and resource ("Check a pairing started with wa_pair_account") with an explicit link to the initiating sibling, which no other sibling tool covers. An agent can distinguish it from wa_list_accounts and wa_pair_account without opening any schema.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines5/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Gives per-state instructions for each value: for state "qr" show the latest image, for state "code" show pair_code, for "password_needed" the user acts on the console's pairing page. It also states an explicit exclusion ("never here") and the terminal condition ("paired" → visible in wa_list_accounts).

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?