Skip to main content
Glama

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. When state becomes "paired" the account is ready and appears in wa_list_accounts.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
pair_idYesthe pair_id returned by wa_pair_account

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
stateYesstarting, qr, paired or failed
pair_idNopass this to wa_pair_status to follow the pairing
refusalNopresent only when pairing could not be started
needs_planNotrue when the linked number has no plan yet and will not run until the user buys one in the console
instructionsNowhat to tell the user to do
qr_png_base64Noa PNG image of the QR code, base64 encoded — display this to the user

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • 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"
      +}
  2. First observed

TDQS

A4.5/5.0
Behavior5/5

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

Explains the non-idempotent behavior (new QR image each call) and the state transition to 'paired', which aligns with idempotentHint: false and readOnlyHint: true. Adds context beyond annotations about how the tool behaves across successive calls.

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?

Three sentences, each adding essential information (purpose, QR behavior, paired outcome). Front-loaded with the core verb and resource; no wasted words.

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?

With an output schema present to define return values, the description covers the complete usage flow: starting point, polling behavior, and terminal state. It even ties to the sibling list tool, so an agent has everything needed to call it 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?

The schema already describes pair_id as 'the pair_id returned by wa_pair_account' with 100% coverage. The description repeats this origin without adding new detail, so it meets the baseline but provides little additional meaning.

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 'Check' and resource 'pairing started with wa_pair_account', clearly distinguishing from siblings by referencing the initiating tool and the resulting list tool. The purpose is unambiguous.

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 clear context: use it after wa_pair_account to poll pairing state. It also indicates when to transition to wa_list_accounts once paired. It does not explicitly state when not to use it, but the workflow is evident.

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