whatsmcp

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

Name	Required	Description	Default
`account_id`	No	optional: report one line's plan; omit to report every line

Output Schema

Name	Required	Description
`plan`	Yes	the plan's slug, e.g. free, starter, pro — an identifier; show display_name to a person
`lines`	No	every line's plan and limits, present only for the workspace view
`refusal`	No	present only when account_id names a line that cannot be used
`voice_plan`	Yes	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
`description`	No	what the plan includes, for a human
`messages_1h`	Yes	the hourly message-send limit and usage
`display_name`	Yes	the plan's name as the customer sees it, e.g. Free, Pro
`history_days`	Yes	how long messages are retained, in days; 0 means forever
`messages_24h`	Yes	the 24-hour message-send limit and usage
`excluded_tools`	No	tools listed on this server that your plan does not include; calling one returns a plan_required refusal
`server_version`	Yes	the version of this MCP service
`accounts_paired`	Yes	WhatsApp numbers currently paired
`webhooks_enabled`	Yes	whether this plan can register inbound webhooks
`max_attachment_mb`	Yes	largest attachment this plan can send, in MB; 0 means unlimited
`server_build_date`	Yes	when that version was built

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

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

First observedSep 27, 2026

TDQS

A4.9/5.0

Behavior5/5

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

Well beyond the readOnlyHint annotation, it explains the non-obvious mechanics: excluded_tools lists only what no active number can use in workspace mode, plan becomes "mixed", and a tool invoked without account_id must be permitted on every active number. Those rules are exactly the failure modes an agent would otherwise misread.

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?

Front-loaded with purpose, then scope, then diagnostic use cases, with zero filler. Some sentences are long and clause-heavy (the excluded_tools and no-account_id rules), costing a little readability, but nothing is redundant.

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?

A one-parameter read-only tool with an output schema; the description still covers mode semantics, refusal implications, and the incidental server_version report. Nothing needed to call it correctly is missing.

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

Parameters5/5

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

Schema coverage is already 100%, but the description adds the consequence of each mode — one number's plan and its excluded_tools versus the workspace intersection and "mixed" plans — which the schema's one-line parameter note does not convey.

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 ("Show a plan, its limits and current usage") and immediately scopes it to WhatsApp numbers vs. the whole workspace. No sibling tool deals with plans or limits, and the description makes that boundary obvious.

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 explicit trigger conditions: call it to diagnose plan_required errors, refusals of wa_send_message, or to check remaining headroom. It also spells out the choice between the two modes — pass account_id for one number, omit for the workspace — with no inference required.

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?