Skip to main content
Glama

Wapiworld WhatsApp API

Check if a WhatsApp number is connected

get_instance_status
Read-onlyIdempotent

Use this when someone asks whether a WhatsApp number is connected, waiting for QR pairing, starting or offline. Returns the instance's name, raw status and a health value: ready, pairing, starting, offline or unknown (no QR codes or credentials). Not for whether a sent message was delivered.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
instanceIdYesInstance id: 24 lowercase hexadecimal characters

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameYes
foundYes
healthYesready: connected; pairing: waiting for a QR scan; starting: connecting; offline: logged out or disconnected; unknown: unrecognized state
statusYes
instanceIdYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / instanceId / description
      Previous value: -"Wapiworld instance id: 24 lowercase hexadecimal characters"New value: +"Instance id: 24 lowercase hexadecimal characters"
    • addedOutput schema / properties / health / description
      Added value: +"ready: connected; pairing: waiting for a QR scan; starting: connecting; offline: logged out or disconnected; unknown: unrecognized state"
  2. First observed

TDQS

A4.5/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, closed-world behavior, so the safety profile is covered. The description adds genuine value beyond that: it lists the returned health vocabulary and clarifies the tool returns no QR codes or credentials, which sets expectations about output. It does not discuss rate limits or error behavior, so it falls just short of a 5.

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, front-loaded with the trigger condition, and every clause earns its place by either scoping usage or enumerating the return vocabulary. No filler.

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-value documentation is not strictly required, yet the description still names the health states. Combined with annotations covering safety, the definition gives an agent everything needed to select and call the 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 coverage is 100% and the single instanceId parameter is fully documented in the schema (24 lowercase hex chars), so the description adds no parameter semantics beyond what structured data provides. 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 ('check whether a WhatsApp number is connected') and enumerates the distinct states it detects (ready, pairing, starting, offline). It also explicitly distinguishes itself from the adjacent concern of message delivery, which is the main sibling confusion for a status tool.

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?

Opens with an explicit trigger ('Use this when someone asks whether a WhatsApp number is connected...') and closes with an explicit exclusion ('Not for whether a sent message was delivered'). Both the when and the when-not are stated, leaving nothing to inference.

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