What is Whatsapp Business Api

The WhatsApp Business API is a tool that allows businesses to communicate with their customers via WhatsApp, enabling automated messaging, customer support, and notifications.

Use cases

Use cases for the WhatsApp Business API include sending order confirmations, providing customer support, sending promotional messages, and conducting surveys.

How to use

To use the WhatsApp Business API, businesses need to set up the API on their server, authenticate using the provided credentials, and integrate it with their existing systems for messaging and customer interaction.

Key features

Key features of the WhatsApp Business API include automated messaging, support for multimedia messages, customer segmentation, message templates, and analytics for tracking engagement.

Where to use

The WhatsApp Business API can be used in various sectors such as e-commerce, customer service, marketing, and any business that requires direct communication with customers.

MCP Server

This project is an MCP (Multi-Agent Conversation Protocol) Server for the given OpenAPI URL - https://api.apis.guru/v2/specs/whatsapp.local/1.0/openapi.json, auto-generated using AG2’s MCP builder.

Prerequisites

• Python 3.9+
• pip and uv

Installation

1. Clone the repository:

   git clone <repository-url>
   cd mcp-server
   

2. Install dependencies:
   The .devcontainer/setup.sh script handles installing dependencies using pip install -e ".[dev]". If you are not using the dev container, you can run this command manually.

   pip install -e ".[dev]"
   

   Alternatively, you can use uv:

   uv pip install --editable ".[dev]"
   

Development

This project uses ruff for linting and formatting, mypy for static type checking, and pytest for testing.

Linting and Formatting

To check for linting issues:

ruff check

To format the code:

ruff format

These commands are also available via the scripts/lint.sh script.

Static Analysis

To run static analysis (mypy, bandit, semgrep):

./scripts/static-analysis.sh

This script is also configured as a pre-commit hook in .pre-commit-config.yaml.

Running Tests

To run tests with coverage:

./scripts/test.sh

This will run pytest and generate a coverage report. For a combined report and cleanup, you can use:

./scripts/test-cov.sh

Pre-commit Hooks

This project uses pre-commit hooks defined in .pre-commit-config.yaml. To install the hooks:

pre-commit install

The hooks will run automatically before each commit.

Running the Server

The MCP server can be started using the mcp_server/main.py script. It supports different transport modes (e.g., stdio, sse).

To start the server (e.g., in stdio mode):

python mcp_server/main.py stdio

The server can be configured using environment variables:

• CONFIG_PATH: Path to a JSON configuration file (e.g., mcp_server/mcp_config.json).
• CONFIG: A JSON string containing the configuration.
• SECURITY: Environment variables for security parameters (e.g., API keys).

Refer to the if __name__ == "__main__": block in mcp_server/main.py for details on how these are loaded.

The tests/test_mcp_server.py file demonstrates how to start and interact with the server programmatically for testing.

Building and Publishing

This project uses Hatch for building and publishing.
To build the project:

hatch build

To publish the project:

hatch publish

These commands are also available via the scripts/publish.sh script.