Skip to main content
Glama
HelloHop WhatsApp MCP

HelloHop WhatsApp MCP

hellohop-mcp

M8ven Verified

HelloHop is an independent WhatsApp API for developers: send and receive messages, automate groups and communities, and get signed webhooks, from $25 USD per number per month with a free sandbox.

This is the HelloHop MCP server. It lets an MCP client (for example Claude Desktop, Claude Code or Cursor) work with one channel of the public API: read the channel's status, the chats it has observed, recent messages, its groups and communities, and a contact. Sending (a text, media by URL, a poll, a reaction) is off by default and available only when you turn it on. Docs: https://hellohop.app/docs/mcp. HelloHop is not affiliated with or endorsed by WhatsApp or Meta.

Install

Requires Node.js 22 or later. Run it with npx, no separate install step:

npx -y hellohop-mcp

Your MCP client starts the server for you once it is configured (see Claude Desktop and Claude Code below). The server reads its settings from the environment variables listed under Environment.

Related MCP server: whatsapp-mcp

Tools

Tool

Request

Notes

channel_status

GET {base}/sessions/{channel}

include_safety: true also reads GET {base}/sessions/{channel}/safety.

list_chats

GET {base}/sessions/{channel}/chats

Up to 100 chats from the channel's own log.

read_messages

GET {base}/sessions/{channel}/chats/{chat}/messages

Up to limit messages (default 50, at most 500); next_before goes back as before. chat is sent as written, for example 15551234567@s.whatsapp.net.

list_groups

GET {base}/sessions/{channel}/groups

Asks WhatsApp; do not poll (a throttled number answers 429 whatsapp_rate_limited).

get_group

GET {base}/sessions/{channel}/groups/{group}

Asks WhatsApp.

get_community

GET {base}/sessions/{channel}/communities/{community}

Asks WhatsApp.

list_community_subgroups

GET {base}/sessions/{channel}/communities/{community}/subgroups

Asks WhatsApp.

get_contact

GET {base}/sessions/{channel}/contacts/{who}

The channel's stored contact entry; does not ask WhatsApp.

send_text

POST {base}/sessions/{channel}/messages/text

Only when GATEWAY_ALLOW_SEND=1. Body {to, text}, plus quoted if given.

send_media

POST {base}/sessions/{channel}/messages/{kind}

Only when GATEWAY_ALLOW_SEND=1. kind is image, video, audio, voice or document; body {to, url} plus caption, filename, mime_type if given. The gateway fetches the URL.

send_poll

POST {base}/sessions/{channel}/messages/poll

Only when GATEWAY_ALLOW_SEND=1. Body {to, question, options} (2 to 12), plus multiple if given.

react

PUT {base}/sessions/{channel}/messages/{message_id}/reaction

Only when GATEWAY_ALLOW_SEND=1. Body {emoji}.

unreact

DELETE {base}/sessions/{channel}/messages/{message_id}/reaction

Only when GATEWAY_ALLOW_SEND=1. No body.

delete_message

DELETE {base}/sessions/{channel}/messages/{message_id}

Only when GATEWAY_ALLOW_SEND=1. No body. Deletes for everyone a message this number sent, within 48 hours.

check_numbers (always registered; it sends no message) starts a number check from 1 to 50 numbers (POST {base}/sessions/{channel}/number-checks, plus refresh if given), or reads one by job_id (GET the check, then a page of its rows with offset, limit and status). The check runs in the background on the channel's own connected non-sandbox number, spaced out, with a daily check allowance by number age, so a long list takes hours or days and it cannot be made faster. The number checker is included with every paid number. The account needs at least one active non-sandbox channel, including one covered by a paid, complimentary, promotional or admin grant. Otherwise the service returns 403 number_checker_requires_paid_number; a sandbox request from an eligible account returns 403 number_checker_requires_non_sandbox_channel. A paused check says why and resumes by itself (only channel_down waits for you; account_suspended must be resolved); a failed check reports its code and reason in failure (check_failed for an upstream failure). Read its reason before retrying. Rows carry phone_e164, country, jid, lid, is_business (present only when true), verified_name, checked_at, and cached with age_seconds. A check is a point-in-time answer and can be wrong or out of date; it does not promise delivery.

Not exposed, on purpose: group and community invite links (an agent could paste an open invite into a chat), media download (bytes, not JSON) and webhook configuration.

get_group returns the group's participant list, which is your own group data, so it enters the MCP client's context like any other tool result. Use it only with a client you trust with those member identities.

The public API forwards only limit (1 to 500) and before on the conversation read, so read_messages pages with those two and no other query string reaches the API. The other list tools take no paging parameters.

A chat is sent in the URL path without percent-encoding, because the API refuses any path containing %. A chat containing anything other than letters, digits and @ . : _ + - is refused before a request is made.

Every request sends Authorization: Bearer <token>. A successful response is returned as JSON text. An HTTP error is returned as a tool error with status, code and error, plus retry_after (and window, resets_at, ambiguous, id) when the API sends them. The token is redacted from every string returned, success bodies included. Nothing is retried automatically, and a redirect is refused rather than followed.

Environment

Variable

Required

Meaning

GATEWAY_API_URL

no

Your API base. Defaults to https://api.hellohop.app/v1, the public API. Must be https (http is accepted only for localhost).

GATEWAY_API_TOKEN

yes

A channel key, or an account key for any number in the account. It is never logged.

GATEWAY_CHANNEL_ID

yes

The one number this server operates on, including when using an account key.

GATEWAY_ALLOW_SEND

no

Set to exactly 1 or true to enable the send tools (send_text, send_media, send_poll, react, unreact, delete_message). Any other value, or unset, leaves them off.

An account key starts with hh_acct_ and works in GATEWAY_API_TOKEN without any other change. GATEWAY_CHANNEL_ID still selects one owned number per server. Create the key in Account in the console; it is shown once. Rotate with Regenerate, then update this configuration. The key cannot manage billing, number slots, credentials, teams, grants or company terms.

If a required variable is missing the server writes the reason to stderr and exits with status 1.

Sending is off by default

Without GATEWAY_ALLOW_SEND=1 no send tool is registered: a client cannot see or call them, and the server never contacts a send endpoint. With it on, every call sends a real WhatsApp message from the linked number (a reaction, its removal and a delete included) and counts as one against the daily message allowance (sandbox channels).

A send can succeed without saying so

A failed send_text carries delivery: "unknown" when the message may have been sent anyway: no response arrived, the API answered ambiguous: true (a 504 send_unconfirmed, with the id of the row it logged), or the answer was any other 502 or 504. Do not send it again. Check read_messages for that chat first. Sending it again is how the same message reaches a real person twice.

Prompt injection: read and send together let strangers steer sends

read_messages puts text written by third parties, anyone who can message the number, into the model's context. With GATEWAY_ALLOW_SEND=1 in the same server, that text can instruct the model to send messages, to anyone, with any content. This is not solved by trusting the client or the person using it: the instructions come from the messages being read.

Run reading and sending as two separate client configurations:

  • a read-only entry, without GATEWAY_ALLOW_SEND, for anything that reads messages;

  • a send entry, with GATEWAY_ALLOW_SEND=1, enabled only in a session that needs to send, with every send_text call approved by a person who reads its to and text.

The send entry still registers the read tools, so a session using it is exposed the moment it reads messages. Keep that session away from read_messages unless you trust everyone who can message the number.

Claude Desktop

Add an entry to mcpServers in claude_desktop_config.json:

{
  "mcpServers": {
    "hellohop-mcp": {
      "command": "npx",
      "args": ["-y", "hellohop-mcp"],
      "env": {
        "GATEWAY_API_TOKEN": "<CHANNEL_TOKEN>",
        "GATEWAY_CHANNEL_ID": "<CHANNEL_ID>"
      }
    }
  }
}

Add "GATEWAY_ALLOW_SEND": "1" to env to enable sending. Restart Claude Desktop after editing the file.

Claude Code

claude mcp add hellohop-mcp \
  -e GATEWAY_API_TOKEN=<CHANNEL_TOKEN> \
  -e GATEWAY_CHANNEL_ID=<CHANNEL_ID> \
  -- npx -y hellohop-mcp

Add -e GATEWAY_ALLOW_SEND=1 before -- to enable sending.

Both clients store the token in their configuration file in plain text. Use the channel's own token, never an operator credential.

Cursor

Add the same entry to ~/.cursor/mcp.json (or .cursor/mcp.json in a project):

{
  "mcpServers": {
    "hellohop-mcp": {
      "command": "npx",
      "args": ["-y", "hellohop-mcp"],
      "env": {
        "GATEWAY_API_TOKEN": "<CHANNEL_TOKEN>",
        "GATEWAY_CHANNEL_ID": "<CHANNEL_ID>"
      }
    }
  }
}

Sending stays off unless you add "GATEWAY_ALLOW_SEND": "1" to env.

Example requests

Once connected, ask your assistant in plain language. For example:

  • "What is the status of my channel?" (calls channel_status)

  • "Show the last 20 messages in my chat with 15551234567@s.whatsapp.net." (calls read_messages)

  • "List the groups this number is in." (calls list_groups)

License

MIT. Full documentation: https://hellohop.app/docs/mcp

Available Tools

8 tools
channel_statusChannel statusA
Read-onlyIdempotent

Read this channel's state from the gateway: whether the number is linked and connected. Set include_safety to also read the channel's health readings and overall verdict.

NameRequiredDescriptionDefault
include_safetyNoAlso read the safety readings (a second GET request). Default false.

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive and openWorld. The description adds genuine extra context beyond them: the state is fetched from a gateway, and enabling include_safety triggers 'a second GET request', disclosing an additional round-trip cost that the annotations do not convey.

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 tight sentences, zero filler, front-loading the core read behavior before the optional-parameter note. Every clause earns its place.

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 no output schema, the description carries the return-value burden and does so: it names the fields returned (linked/connected status, plus health readings and overall verdict when requested). Combined with annotations covering the safety profile, 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?

Schema description coverage is 100% and the single parameter is already documented in the schema ('Also read the safety readings (a second GET request). Default false.'). The description largely restates that, adding only the framing that the readings include an 'overall verdict', so the 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?

The description states a specific verb and resource ('Read this channel's state from the gateway') and immediately enumerates what that state contains ('whether the number is linked and connected'). The sibling tools operate on entirely different resources (chats, contacts, groups), so no differentiation is needed and none is ambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

It implies the use case (checking a channel's linkage/connection) and gives conditional guidance for include_safety, but never states when to prefer this over another call or any prerequisite/exclusion. Usage is inferable rather than explicit.

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

get_communityGet a communityA
Read-onlyIdempotent

Read one community this channel's number belongs to. This asks WhatsApp itself; do not poll it. A 429 whatsapp_rate_limited means WhatsApp is throttling the number: wait retry_after seconds.

NameRequiredDescriptionDefault
communityYesThe community JID, for example 120363000000000002@g.us.

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare readOnly/idempotent/openWorld/no-destructive, so the safety profile is covered. The description adds genuinely new behavior: the call hits WhatsApp live rather than cached data, must not be polled, and surfaces a 429 whatsapp_rate_limited with a retry_after wait — useful beyond the annotations. It does not describe auth requirements or not-found handling.

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 tight sentences, each carrying distinct information (what it reads, the no-poll constraint, the rate-limit remedy), with the purpose front-loaded. Nothing is redundant.

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?

With no output schema, the description focuses on invocation behavior and error handling, which is the right allocation for a single-resource read. It leaves the failure modes for an invalid or inaccessible community JID unaddressed, so it is strong but not fully complete.

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 'community' parameter is documented there with an example JID format, so the description correctly defers. It adds no syntax or format detail beyond the schema, which is the expected baseline rather than added value.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Read one community') and adds a scoping constraint ('this channel's number belongs to'), which clearly separates it from the list-style siblings like list_community_subgroups. It does not explicitly name the nearest alternative (get_group), so it falls short of a 5.

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 actionable timing guidance ('do not poll it') and explains what to do when throttled (wait retry_after on a 429), which is real when-to-use context. It stops short of naming an alternative tool or stating when a different sibling should be used instead.

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

get_contactGet a contactA
Read-onlyIdempotent

Read this channel's stored entry for one contact (the names its contact store holds); this does not ask WhatsApp. who is a phone JID such as 15551234567@s.whatsapp.net, or a LID.

NameRequiredDescriptionDefault
whoYesThe contact: a user JID or a LID.

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive, and openWorld, so the safety profile is covered. The description adds genuinely useful context beyond them: the read is against the channel's local contact store and does not hit WhatsApp, which tells the agent the data may be stale/incomplete compared to a live lookup.

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 the core action, then the scoping caveat, then the parameter format. Two compact clauses with no filler; only minor density in the parenthetical.

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?

With no output schema, the description usefully notes the entry is the names the contact store holds, so the agent knows roughly what comes back. It omits what happens when the contact is absent from the store (null vs error), a small remaining gap for a single-param read tool.

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 coverage is 100% and the schema already says 'a user JID or a LID', but the description adds a concrete format example (15551234567@s.whatsapp.net), which materially helps the agent construct a valid value.

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+resource ('read this channel's stored entry for one contact') and immediately scopes it as the local contact store rather than a live WhatsApp lookup. This distinguishes it from the sibling chat/message/group tools, which all operate on other resources.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies the use case (resolve a stored contact entry locally) and rules out the WhatsApp-query interpretation, but it names no alternative tool and gives no explicit when-to-use/when-not-to-use condition beyond the 'does not ask WhatsApp' scope note.

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

get_groupGet a groupA
Read-onlyIdempotent

Read one group: its subject, description, settings and participants. This asks WhatsApp itself; do not poll it. A 429 whatsapp_rate_limited means WhatsApp is throttling the number: wait retry_after seconds.

NameRequiredDescriptionDefault
groupYesThe group JID, for example 120363000000000001@g.us.

TDQS

A4/5.0
Behavior4/5

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

Annotations already declare readOnly, idempotent, non-destructive and open-world, so the safety profile is covered. The description adds genuinely new behavioral context beyond that: the call hits WhatsApp live, must not be polled, and a 429 whatsapp_rate_limited response carries a retry_after backoff. That is meaningful operational disclosure.

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 short sentences, each earning its place: purpose first, then the live-call/no-poll constraint, then the rate-limit behavior. Front-loaded and waste-free.

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?

With no output schema, the description compensates by naming the returned contents (subject, description, settings, participants) and the failure mode (429 with retry_after). Largely complete for a one-param read tool, though it omits any auth/permission prerequisites.

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% on the single 'group' param (JID format example included), so the schema carries the burden. The description adds no parameter-level detail beyond the schema, which is the baseline case for high coverage.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource ('Read one group') and enumerates what is returned (subject, description, settings, participants). This distinguishes it from list_groups by scoping to a single group, though it never names that sibling explicitly.

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 an explicit usage constraint — 'This asks WhatsApp itself; do not poll it' — which is an actionable when-not-to-do instruction. It does not, however, route the agent to an alternative (e.g., list_groups for enumerating), so it falls short of full alternative-naming guidance.

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

list_chatsList chatsA
Read-onlyIdempotent

List the chats the gateway has observed on this channel, from its own message log. This is not the account's full chat list: chats with no activity since the number was linked are absent. Returns up to 100 chats; the public API does not accept paging parameters.

NameRequiredDescriptionDefault

No parameters

TDQS

A4.7/5.0
Behavior5/5

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

Annotations already declare this a safe read (readOnly, idempotent, non-destructive), so the bar is lower, yet the description adds real behavioral context: the data source is the gateway's own message log, coverage is limited to chats with activity since linking, and results cap at 100 with no paging available.

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 tight sentences, front-loaded with the core action and scope before the caveats. Every sentence adds a distinct constraint an agent needs.

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 no output schema, the description still discloses the return cap (up to 100) and absence of paging, plus the coverage limitation. Nothing material for correct invocation is 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?

The tool takes zero parameters, so there is nothing for the description to compensate for; baseline 4 applies. The note about no paging parameters is useful but concerns the API, not input arguments.

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 (list) and resource (chats) and immediately scopes it: chats the gateway has observed on this channel from its own message log. This distinguishes it from a general account chat list and from siblings like list_groups.

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?

Clarifies the operating context by explicitly ruling out the full account chat list and noting that chats with no activity since the number was linked are absent. It doesn't name a sibling alternative to use instead, but the scope conditions are clear enough to guide selection.

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

list_community_subgroupsList a community's subgroupsA
Read-onlyIdempotent

List the groups linked to a community. This asks WhatsApp itself; do not poll it. A 429 whatsapp_rate_limited means WhatsApp is throttling the number: wait retry_after seconds.

NameRequiredDescriptionDefault
communityYesThe community JID, for example 120363000000000002@g.us.

TDQS

A4.1/5.0
Behavior5/5

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

Goes well beyond the annotations (which only cover safety/idempotency) by disclosing that the call hits WhatsApp live, that polling is discouraged, and how a 429 throttling response should be handled via retry_after. This is exactly the kind of runtime behavior an agent needs to invoke it correctly.

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 short sentences, front-loaded with the purpose, followed by the two behavioral caveats. No filler or repetition.

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?

For a single-parameter read-only list tool with no output schema and full schema coverage, the description covers purpose plus the important rate-limit and freshness behavior. It could mention the shape of what is returned (e.g. group identifiers), but nothing essential for correct invocation 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 schema documents the single community parameter with a JID example. The description adds no additional parameter meaning, so the baseline 3 applies.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb and resource with scope: 'List the groups linked to a community.' The community-scoping requirement implicitly separates it from the unscoped list_groups, though no sibling is named explicitly.

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 a clear operational directive ('This asks WhatsApp itself; do not poll it') and concrete recovery guidance for the 429 whatsapp_rate_limited case including waiting retry_after seconds. It stops short of naming an alternative tool for other listing needs.

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

list_groupsList groupsA
Read-onlyIdempotent

List the WhatsApp groups this channel's number is in. This asks WhatsApp itself; do not poll it. A 429 whatsapp_rate_limited means WhatsApp is throttling the number: wait retry_after seconds.

NameRequiredDescriptionDefault

No parameters

TDQS

A3.9/5.0
Behavior4/5

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

Annotations already cover read-only, idempotent, non-destructive, open-world behavior. The description adds value beyond them: it states the data comes from WhatsApp itself (fresh, not cached), warns against polling, and explains the 429 whatsapp_rate_limited response with retry_after. Return shape and pagination behavior remain unstated.

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 short sentences, front-loaded with what is listed, followed by the polling warning and the rate-limit contract. Every sentence carries actionable information with no filler.

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?

For a no-parameter, no-output-schema read tool, the description supplies the important operational context (source of truth, no polling, 429 handling). It stops short of describing what each returned group contains, which would be the only remaining gap given there is no output schema.

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?

The tool takes zero parameters, so per the rubric the baseline is 4. The description correctly implies a no-argument call, and there are no parameter semantics to add.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

States a specific verb (List) plus resource (WhatsApp groups) and scopes it to "this channel's number is in," so an agent knows it returns group membership for the connected number. It does not explicitly distinguish itself from the group-related sibling get_group or from list_chats, so it falls short of 5.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

"do not poll it" is an explicit usage constraint, which is more than nothing, but there is no guidance on when to prefer this over get_group or list_chats, and no stated prerequisites. Usage is implied rather than framed against alternatives.

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

read_messagesRead a conversationA
Read-onlyIdempotent

Read one conversation from this channel's message log, newest first: a person or a group. For a person, both of their WhatsApp addresses (phone number and LID) are read as one timeline where the channel holds the lid_lookup grant; merge says whether that happened, and each message's source_chat says which address it came from. In a group, each sender is one identity (sender_jid, with sender_lid beside it). Pages hold up to limit messages (default 50); when next_before is present, pass it as before to read the next, older page. Only messages captured while the channel was connected are present, plus history the phone sent if the channel stores it (source: history_sync). Every page read is recorded in the channel's API access records.

NameRequiredDescriptionDefault
chatYesThe chat: a JID such as 15551234567@s.whatsapp.net or 120363000000000000@g.us, or a phone number in international form. Use chat_jid values from list_chats.
limitNoMessages per page, 1 to 500. Default 50.
beforeNoThe next_before value of a previous page, exactly as returned.

TDQS

A4.4/5.0
Behavior5/5

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

Annotations cover the safety profile (readOnly, idempotent, non-destructive), and the description adds substantial context beyond them: lid_lookup merging behavior, the merge and source_chat indicators, history_sync provenance, pagination via next_before, and that every page read is recorded in the channel's API access records.

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 purpose and scoping constraint are front-loaded in the first clause. The remaining sentences are dense but each carries distinct operational information, though the middle section is information-rich enough to be slightly heavy for a single paragraph.

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 no output schema, the description carries return-value context well by naming the fields an agent will see (merge, source_chat, sender_jid, sender_lid, next_before) and explaining provenance limitations. 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.

Parameters4/5

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

Schema coverage is 100%, so the baseline is 3, but the description goes further by explaining the pagination flow (next_before -> before), restating the default limit of 50, and clarifying that chat can denote either a person or a group.

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 (read one conversation from this channel's message log) and immediately scopes it to a person or a group. It is clearly distinguishable from siblings like list_chats, get_contact, or get_group, which list rather than read message history.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

Usage is implied: read a conversation once you know the chat, and paginate by passing next_before as before. However, it never states when to prefer this tool over siblings or any exclusions/prerequisites, so guidance is only inferable rather than explicit.

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

Tool Schema Changelog

Recent tool additions, removals, and schema changes observed during successful MCP inspections.

  1. 8 tool updatesv0.2.0
    • First observedchannel_status
    • First observedget_community
    • First observedget_contact
    • First observedget_group
    • First observedlist_chats
    • First observedlist_community_subgroups
    • First observedlist_groups
    • First observedread_messages

TDQS

A4.1/5.0

Scored across 8 tools

Disambiguation4/5

Each tool targets a distinct resource (channel status, chats, contacts, messages, groups, communities). The main potential confusion is list_chats (from the gateway's log) versus list_groups (queried from WhatsApp), but the descriptions explicitly spell out this log-vs-live distinction, so misselection risk is low.

Naming Consistency4/5

Most tools follow a clean verb_noun pattern (list_chats, get_contact, read_messages, list_groups, get_group, get_community, list_community_subgroups). The lone deviation is channel_status (noun_state) and the minor read_ vs get_ split for retrieval, but the set is highly readable overall.

Tool Count5/5

Eight tools is well-scoped for a WhatsApp gateway: channel health, chat/message reading, contacts, groups, and communities each earn their place without redundancy.

Completeness3/5

The surface is coherent but read-only: there is no send-message tool, no list_contacts (only get_contact), and no way to create or modify groups, which are obvious lifecycle gaps for a messaging-domain server. Core read workflows are covered, but agents will hit dead ends for any write action.

Maintenance

ActivityMaintained
ResponsivenessNo issues

Related MCP Connectors

Related MCP Servers

  • A
    license
    Not graded
    quality
    A
    maintenance
    Enables MCP clients to read, search, and send WhatsApp messages with a server-enforced send gate for safety.
    2
    MIT
  • A
    license
    Not graded
    quality
    C
    maintenance
    Enables agents and MCP clients to read and send WhatsApp messages and media, search chats, and manage contacts and groups after a one-time QR pairing.
    44 npm
    MIT
  • A
    license
    Not graded
    quality
    B
    maintenance
    Enables MCP clients to read, search, and send personal WhatsApp messages and files through a locally linked device.
    44 npm
    MIT
  • A
    license
    Not graded
    quality
    B
    maintenance
    Lets any MCP client read, search, and optionally send messages from a linked personal WhatsApp account through a hosted endpoint secured by a bearer token.
    3
    MIT