WhatsMCP: MCP for WhatsApp

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

Changed3 schema fields changedOct 11, 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"
+}

Changed3 schema fields changedOct 11, 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"
+}

changedOutput schema / properties / state / description

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

Changed1 schema field changedSep 24, 2026

addedOutput schema / properties / needs_plan

Added value: +{
+  "description": "true when the linked number has no plan yet and will not run until the user buys one in the console",
+  "type": "boolean"
+}

First observedSep 17, 2026

TDQS

A4.1/5.0

Behavior4/5

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

Adds context the annotations can't carry: the non-idempotent character (new image returned on each call, so show the latest) and the security-relevant 'password_needed' path where the user must enter their cloud password on the console page, never in this tool. It does not mention whether pair_id expires or how long pairing sessions live, which is the main remaining behavioral unknown.

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

Conciseness4/5

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

Four short, front-loaded sentences that map cleanly onto state branches; no filler. Slightly dense, but each sentence carries actionable information and the ordering follows the agent's decision flow.

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 needn't be enumerated, yet the description still explains the meaningful state values and how to act on each. Combined with the password-handling caveat, an agent has enough to call and interpret this correctly; only session lifetime/polling cadence 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?

Schema description coverage is 100% and the single parameter's schema text ('the pair_id returned by wa_pair_account') already carries the full meaning. The description only repeats the provenance of pair_id, adding no format or constraint detail beyond the schema.

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?

Opens with a specific verb and resource ('Check a pairing started with wa_pair_account'), and immediately ties itself to the sibling that starts the flow, so an agent can distinguish the initiate step from the poll step without opening either schema.

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?

States the precondition (a pairing started with wa_pair_account) and gives per-state instructions: show the latest image while 'qr', show pair_code while 'code', and treat 'paired' as readiness signalled by wa_list_accounts. It stops short of telling the agent how often to poll or when to give up, which is a real gap for a polling tool.

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

All WhatsMCP: MCP for WhatsApp 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?