WSAPI

Provides MCP access to WSAPI features for messaging, contacts, groups, and more through WhatsApp.

javascript

2

GitHub Stars

javascript

Language

6 months ago

First Indexed

2 months ago

Catalog Refreshed

Documentation & install

Readme and setup notes from the catalogue, plus a client-ready config you can copy for your MCP host.

Installation

Add the following to your MCP client configuration file.

Configuration

View docs

{
  "mcpServers": {
    "wsapi-chat-wsapi-mcp": {
      "command": "npx",
      "args": [
        "@wsapichat/mcp-server"
      ],
      "env": {
        "WSAPI_API_KEY": "YOUR_API_KEY",
        "WSAPI_INSTANCE_ID": "YOUR_INSTANCE_ID",
        "WSAPI_ENABLED_CATEGORIES": "messaging,contacts"
      }
    }
  }
}

A Model Context Protocol (MCP) server for WSAPI enables your client applications to interact with WhatsApp through WSAPI by loading a configurable set of tools and capabilities. You can manage messaging, contacts, groups, communities, newsletters, status updates, and more by running this MCP server locally or in your environment and connecting it to your MCP client.

How to use

You will run the MCP server as a local or remote service and connect your MCP client to it. The server exposes a set of tools across categories such as messaging and contacts that your client can invoke to send messages, fetch contacts, manage chats, and perform related actions. Configure the server with your WSAPI credentials and choose which tool categories or individual tools to load to optimize performance and context windows.

How to install

Prerequisites you need before installation are Node.js version 20 or later and a WSAPI account with API credentials.

Follow these concrete steps to install and run the MCP server.

# Install and run the MCP server using npm with standard initialization
git clone https://github.com/wsapi-chat/wsapi-mcp
cd wsapi-mcp
npm install
cp .env.example .env  # Edit with your credentials
npm run build
npm start

# If you prefer to invoke the MCP server via npx directly
npx @wsapichat/mcp-server

Configuration

Configure the server to load only the tools you need and to provide your WSAPI credentials. The server relies on environment variables to authenticate with WSAPI and to enable specific tool categories.

{
  "mcpServers": {
    "wsapi": {
      "command": "npx",
      "args": ["@wsapichat/mcp-server"],
      "env": {
        "WSAPI_API_KEY": "your_api_key_here",
        "WSAPI_INSTANCE_ID": "your_instance_id_here",
        "WSAPI_ENABLED_CATEGORIES": "messaging,contacts"
      }
    }
  }
}