Skip to main content
Glama

Wapiworld WhatsApp API

Show Wapiworld project overview

show_project_overview
Read-onlyIdempotent

Use this when someone wants a quick overview or dashboard of one Wapiworld project's WhatsApp numbers. Returns an overview card with the project name, how many instances are ready, pairing, starting, offline or unknown (counting up to 100), and up to 20 instances with phone and status. Not for sending a message.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
projectIdYesProject id

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
projectYes
instancesYesUp to 20 instances. QR pairing codes, instance credentials, API keys, proxy data and arbitrary stored fields are excluded.
statusCountsYes
instanceCountYes
instanceCountIsLowerBoundYes
statusCountsAreLowerBoundsYes

Schema Changelog

Changes observed during successful MCP inspections.

  1. Changed2 schema fields changed
    • changedInput schema / properties / projectId / description
      Previous value: -"Wapiworld project id to summarize"New value: +"Project id"
    • addedOutput schema / properties / instances / description
      Added value: +"Up to 20 instances. QR pairing codes, instance credentials, API keys, proxy data and arbitrary stored fields are excluded."
  2. First observed

TDQS

A4.1/5.0
Behavior4/5

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

Annotations already declare readOnlyHint, idempotentHint, non-destructive and closed-world, so safety is covered. The description adds genuinely useful behavioral context beyond them: the status counts cap at 100 and only up to 20 instances are returned, which tells the agent results may be truncated. It does not mention permissions or error behavior, but those are minor for a read-only dashboard.

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 usage trigger, then the return shape, then the exclusion. Every sentence carries distinct information with no repetition or padding.

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?

For a single-parameter read-only tool with an output schema and full annotation coverage, the definition supplies the usage trigger, the return shape, the truncation limits, and an exclusion. Nothing an agent needs in order to call this correctly 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 there is only one required parameter, projectId, so the schema carries the burden. The description adds no format, ID-source, or lookup guidance beyond what the schema already states, 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 concrete verb and resource ('quick overview or dashboard of one Wapiworld project's WhatsApp numbers') and enumerates the card contents, so the agent knows exactly what comes back. It partially differentiates from siblings via the 'one project' scope and the explicit 'Not for sending a message', but never contrasts itself with list_instances or list_projects, which return overlapping data at a different granularity.

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?

'Use this when someone wants a quick overview or dashboard' gives a clear triggering intent, and 'Not for sending a message' supplies one exclusion. However, the real ambiguity for this tool is overview-vs-list (list_instances, list_projects) and that boundary is left unaddressed.

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