Skip to main content
Glama

WhatsMCP: MCP for WhatsApp

Get Plan

wa_get_plan
Read-only

Show a plan, its limits and current usage. Plans are per WhatsApp number: pass account_id to see ONE number's plan, limits and the tools it does not include (excluded_tools); omit it for the whole workspace — every number's plan and limits (lines), with excluded_tools listing only what NO active number can use, and plan "mixed" when the numbers are on different plans. A tool listed on this server may still be refused on a number whose plan leaves it out; a tool called WITHOUT account_id acts on every number, so it needs every active number's plan to include it. Call this to see why a tool answers plan_required on a given number, why wa_send_message might be refused, or how much headroom is left. It also reports this service's version (server_version, server_build_date).

Input Schema

NameRequiredDescriptionDefault
account_idNooptional: report one line's plan; omit to report every line

Output Schema

NameRequiredDescriptionDefault
planYesthe plan's slug, e.g. free, starter, pro — an identifier; show display_name to a person
linesNoevery line's plan and limits, present only for the workspace view
refusalNopresent only when account_id names a line that cannot be used
voice_planYesthe SIP calls this plan allows, or null when it allows none — or, for a workspace whose numbers are on different plans, null: see each line's calls_inbound/calls_outbound
descriptionNowhat the plan includes, for a human
messages_1hYesthe hourly message-send limit and usage
display_nameYesthe plan's name as the customer sees it, e.g. Free, Pro
history_daysYeshow long messages are retained, in days; 0 means forever
messages_24hYesthe 24-hour message-send limit and usage
excluded_toolsNotools listed on this server that your plan does not include; calling one returns a plan_required refusal
server_versionYesthe version of this MCP service
accounts_pairedYesWhatsApp numbers currently paired
webhooks_enabledYeswhether this plan can register inbound webhooks
max_attachment_mbYeslargest attachment this plan can send, in MB; 0 means unlimited
server_build_dateYeswhen that version was built

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed1 schema field changed
    • 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"
      +  ]
      +}
  2. Changed3 schema fields changed
    • 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"
      +}
  3. Changed2 schema fields changed
    • addedOutput schema / properties / lines / additionalProperties / properties / rest_api
      Added value: +{
      +  "description": "whether this number may be reached over the WhatsMCP REST API as well as this MCP server",
      +  "type": "boolean"
      +}
    • changedOutput schema / properties / lines / additionalProperties / required
      Previous value: -[
      -  "plan",
      -  "display_name",
      -  "phone",
      -  "live",
      -  "messages_1h",
      -  "messages_24h",
      -  "max_attachment_mb",
      -  "history_days",
      -  "webhooks_enabled",
      -  "calls_inbound",
      -  "calls_outbound",
      -  "primary_device",
      -  "secondary_device"
      -]New value: +[
      +  "plan",
      +  "display_name",
      +  "phone",
      +  "live",
      +  "messages_1h",
      +  "messages_24h",
      +  "max_attachment_mb",
      +  "history_days",
      +  "webhooks_enabled",
      +  "calls_inbound",
      +  "calls_outbound",
      +  "primary_device",
      +  "secondary_device",
      +  "rest_api"
      +]
  4. Changed3 schema fields changed
    • addedOutput schema / properties / lines / additionalProperties / properties / primary_device
      Added value: +{
      +  "description": "whether this number's plan lets it run as its own main WhatsApp device, with no phone",
      +  "type": "boolean"
      +}
    • addedOutput schema / properties / lines / additionalProperties / properties / secondary_device
      Added value: +{
      +  "description": "whether this number's plan lets it run as a linked device beside the WhatsApp app on a phone",
      +  "type": "boolean"
      +}
    • changedOutput schema / properties / lines / additionalProperties / required
      Previous value: -[
      -  "plan",
      -  "display_name",
      -  "phone",
      -  "live",
      -  "messages_1h",
      -  "messages_24h",
      -  "max_attachment_mb",
      -  "history_days",
      -  "webhooks_enabled",
      -  "calls_inbound",
      -  "calls_outbound"
      -]New value: +[
      +  "plan",
      +  "display_name",
      +  "phone",
      +  "live",
      +  "messages_1h",
      +  "messages_24h",
      +  "max_attachment_mb",
      +  "history_days",
      +  "webhooks_enabled",
      +  "calls_inbound",
      +  "calls_outbound",
      +  "primary_device",
      +  "secondary_device"
      +]
  5. Changed3 schema fields changed
    • addedOutput schema / properties / voice_plan / properties / sip
      Added value: +{
      +  "description": "whether your calls may connect to a SIP phone or your own PBX",
      +  "type": "boolean"
      +}
    • addedOutput schema / properties / voice_plan / properties / webrtc
      Added value: +{
      +  "description": "whether you may take and place your calls from the browser",
      +  "type": "boolean"
      +}
    • changedOutput schema / properties / voice_plan / required
      Previous value: -[
      -  "name",
      -  "label",
      -  "calls_inbound",
      -  "calls_outbound",
      -  "calls_ai"
      -]New value: +[
      +  "name",
      +  "label",
      +  "calls_inbound",
      +  "calls_outbound",
      +  "calls_ai",
      +  "sip",
      +  "webrtc"
      +]
  6. Changed6 schema fields changed
    • addedInput schema / properties
      Added value: +{
      +  "account_id": {
      +    "description": "optional: report one line's plan; omit to report every line",
      +    "type": "string"
      +  }
      +}
    • addedOutput schema / properties / lines
      Added value: +{
      +  "additionalProperties": {
      +    "additionalProperties": false,
      +    "properties": {
      +      "calls_inbound": {
      +        "description": "whether an incoming WhatsApp call to this number may ring your SIP PBX",
      +        "type": "boolean"
      +      },
      +      "calls_outbound": {
      +        "description": "whether your SIP PBX may place WhatsApp calls from this number",
      +        "type": "boolean"
      +      },
      +      "display_name": {
      +        "description": "the line's plan as the customer sees it",
      +        "type": "string"
      +      },
      +      "history_days": {
      +        "description": "how long this number's messages are retained, in days; 0 means forever",
      +        "type": "integer"
      +      },
      +      "live": {
      +        "description": "false when this number is released, locked, unlinked or dormant — its plan then unlocks nothing for the workspace",
      +        "type": "boolean"
      +      },
      +      "max_attachment_mb": {
      +        "description": "largest attachment this number can send, in MB; 0 means unlimited",
      +        "type": "integer"
      +      },
      +      "messages_1h": {
      +        "description": "messages this number's plan allows per hour; 0 means unlimited",
      +        "type": "integer"
      +      },
      +      "messages_24h": {
      +        "description": "messages this number's plan allows per 24 hours; 0 means unlimited",
      +        "type": "integer"
      +      },
      +      "phone": {
      +        "description": "the line's WhatsApp number",
      +        "type": "string"
      +      },
      +      "plan": {
      +        "description": "the line's plan slug",
      +        "type": "string"
      +      },
      +      "webhooks_enabled": {
      +        "description": "whether this number's plan includes webhooks",
      +        "type": "boolean"
      +      }
      +    },
      +    "required": [
      +      "plan",
      +      "display_name",
      +      "phone",
      +      "live",
      +      "messages_1h",
      +      "messages_24h",
      +      "max_attachment_mb",
      +      "history_days",
      +      "webhooks_enabled",
      +      "calls_inbound",
      +      "calls_outbound"
      +    ],
      +    "type": "object"
      +  },
      +  "description": "every line's plan and limits, present only for the workspace view",
      +  "type": "object"
      +}
    • removedOutput schema / properties / max_accounts
      Removed value: -{
      -  "description": "WhatsApp numbers this plan allows paired; 0 means unlimited",
      -  "type": "integer"
      -}
    • addedOutput schema / properties / refusal
      Added value: +{
      +  "additionalProperties": false,
      +  "description": "present only when account_id names a line that cannot be used",
      +  "properties": {
      +    "message": {
      +      "description": "a human-readable explanation",
      +      "type": "string"
      +    },
      +    "reason": {
      +      "description": "why the call was declined",
      +      "type": "string"
      +    },
      +    "refused": {
      +      "description": "true when the call was declined rather than performed",
      +      "type": "boolean"
      +    },
      +    "retry_after_seconds": {
      +      "description": "seconds to wait before retrying; absent or 0 means retrying will not help",
      +      "type": "integer"
      +    }
      +  },
      +  "required": [
      +    "refused",
      +    "reason",
      +    "message"
      +  ],
      +  "type": [
      +    "null",
      +    "object"
      +  ]
      +}
    • changedOutput schema / properties / voice_plan / description
      Previous value: -"your voice plan (SIP calls), or null when you hold none; without one no SIP call runs"New value: +"the SIP calls this plan allows, or null when it allows none — or, for a workspace whose numbers are on different plans, null: see each line's calls_inbound/calls_outbound"
    • changedOutput schema / required
      Previous value: -[
      -  "plan",
      -  "display_name",
      -  "server_version",
      -  "server_build_date",
      -  "max_accounts",
      -  "accounts_paired",
      -  "messages_1h",
      -  "messages_24h",
      -  "webhooks_enabled",
      -  "max_attachment_mb",
      -  "history_days",
      -  "voice_plan"
      -]New value: +[
      +  "plan",
      +  "display_name",
      +  "server_version",
      +  "server_build_date",
      +  "accounts_paired",
      +  "messages_1h",
      +  "messages_24h",
      +  "webhooks_enabled",
      +  "max_attachment_mb",
      +  "history_days",
      +  "voice_plan"
      +]
  7. Changed3 schema fields changed
    • addedOutput schema / properties / server_build_date
      Added value: +{
      +  "description": "when that version was built",
      +  "type": "string"
      +}
    • addedOutput schema / properties / server_version
      Added value: +{
      +  "description": "the version of this MCP service",
      +  "type": "string"
      +}
    • changedOutput schema / required
      Previous value: -[
      -  "plan",
      -  "display_name",
      -  "max_accounts",
      -  "accounts_paired",
      -  "messages_1h",
      -  "messages_24h",
      -  "webhooks_enabled",
      -  "max_attachment_mb",
      -  "history_days",
      -  "voice_plan"
      -]New value: +[
      +  "plan",
      +  "display_name",
      +  "server_version",
      +  "server_build_date",
      +  "max_accounts",
      +  "accounts_paired",
      +  "messages_1h",
      +  "messages_24h",
      +  "webhooks_enabled",
      +  "max_attachment_mb",
      +  "history_days",
      +  "voice_plan"
      +]
  8. Changed2 schema fields changed
    • addedOutput schema / properties / voice_plan / properties / calls_ai
      Added value: +{
      +  "description": "whether your plan allows connecting an AI agent to your calls",
      +  "type": "boolean"
      +}
    • changedOutput schema / properties / voice_plan / required
      Previous value: -[
      -  "name",
      -  "label",
      -  "calls_inbound",
      -  "calls_outbound"
      -]New value: +[
      +  "name",
      +  "label",
      +  "calls_inbound",
      +  "calls_outbound",
      +  "calls_ai"
      +]
  9. Changed2 schema fields changed
    • addedOutput schema / properties / voice_plan
      Added value: +{
      +  "additionalProperties": false,
      +  "description": "your voice plan (SIP calls), or null when you hold none; without one no SIP call runs",
      +  "properties": {
      +    "calls_inbound": {
      +      "description": "whether an incoming WhatsApp call may ring your SIP PBX",
      +      "type": "boolean"
      +    },
      +    "calls_outbound": {
      +      "description": "whether your SIP PBX may place WhatsApp calls",
      +      "type": "boolean"
      +    },
      +    "label": {
      +      "description": "the voice plan's name as the customer sees it",
      +      "type": "string"
      +    },
      +    "name": {
      +      "description": "the voice plan's slug — an identifier; show label to a person",
      +      "type": "string"
      +    }
      +  },
      +  "required": [
      +    "name",
      +    "label",
      +    "calls_inbound",
      +    "calls_outbound"
      +  ],
      +  "type": [
      +    "null",
      +    "object"
      +  ]
      +}
    • changedOutput schema / required
      Previous value: -[
      -  "plan",
      -  "display_name",
      -  "max_accounts",
      -  "accounts_paired",
      -  "messages_1h",
      -  "messages_24h",
      -  "webhooks_enabled",
      -  "max_attachment_mb",
      -  "history_days"
      -]New value: +[
      +  "plan",
      +  "display_name",
      +  "max_accounts",
      +  "accounts_paired",
      +  "messages_1h",
      +  "messages_24h",
      +  "webhooks_enabled",
      +  "max_attachment_mb",
      +  "history_days",
      +  "voice_plan"
      +]
  10. First observed

TDQS

A4.8/5.0
Behavior5/5

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

The readOnlyHint: true annotation is consistent with a 'Show' operation, and the description adds substantial behavioral context beyond the annotation: per-number plan gating, excluded_tools semantics, the 'mixed' plan case, and why a tool may work on one number but be refused on another. This is exactly the kind of plan-enforcement information an agent needs before calling dependent tools.

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?

The description is front-loaded and every major clause carries useful information, but it is a dense, long paragraph with several semicolon-separated qualifications. It remains readable for a complex diagnostic tool, though a little more structure would improve scanability.

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?

Given the output schema and read-only annotation, the description supplies the remaining context an agent needs: when to use it, how the account_id scope changes the results, and how to interpret plan-based tool refusals. Nothing essential for correct invocation appears to be missing.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters4/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the basic meaning of account_id is already documented. The description still adds real meaning beyond the schema by explaining the different excluded_tools interpretation for one number versus the workspace and the 'mixed' plan result when omitting account_id.

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?

The description gives a specific verb and resource: it shows a plan, its limits, and current usage. It also clearly distinguishes the two scopes, one number with account_id versus the whole workspace without it, which lets an agent separate this from sibling listing and messaging tools.

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?

It explicitly says when to call it: to diagnose plan_required errors, understand why wa_send_message may be refused, or check remaining headroom. It also explains the key usage decision, passing account_id for one number and omitting it for every number, so the agent does not have to infer the routing.

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