Skip to content

MCP

WhatsGate provides a tenant MCP server so AI clients can read device status and reports, and send messages using the same API token and plan limits as your REST API access.

For copy-ready client examples, see MCP Setup.

Public Docs MCP

Use the public docs MCP manifest when you want an AI client to discover WhatsGate documentation without exposing a tenant token:

text
https://whatsgate.net/docs/mcp

This public endpoint is read-only and does not require authentication. It links to the setup guide and the private tenant MCP URL template.

MCP URL

Use this private endpoint only for tenant account actions:

https://{subdomain}.whatsgate.net/mcp/whatsgate

Authentication

Use the API token from your dashboard as a bearer token:

http
Authorization: Bearer {api_token}

The REST API still uses:

http
Access-Token: {api_token}

Available Tools

ToolDescription
send_text_messageSend a text message
send_media_messageSend an image, video, audio, or file
send_location_messageSend a location message
get_device_statusGet one device connection status
list_devices_statusList all device statuses
get_device_balanceGet today's device usage and remaining balance
get_failed_numbersGet failed recipient numbers

Available Resources

ResourceDescription
api-overviewBase URLs, authentication, and rate limit
auth-guideREST and MCP authentication details
message-schemasMessage request fields and endpoint mapping
device-report-schemasDevice and report response fields

Client Configuration

Use the setup template in MCP Setup. A typical MCP client configuration uses placeholders like this:

json
{
  "url": "https://{subdomain}.whatsgate.net/mcp/whatsgate",
  "headers": {
    "Authorization": "Bearer {api_token}"
  }
}

Errors

  • Missing or invalid bearer token: 403 Forbidden
  • Plan does not include API access: 403 Forbidden
  • Invalid tool input: validation error returned to the MCP client

Released under the MIT License.