Gallabox MCP Server

🚀 Gallabox MCP Server

The MCP (Message Communication Protocol) server for the Gallabox API, enabling interaction with WhatsApp messages.

🚀 Quick Start

This server is designed to facilitate seamless interaction with WhatsApp messages through the Gallabox API.

✨ Features

Available Tools

1. sendTextMessage

   • Send a text message to WhatsApp.
   • Required Inputs:
     • recipient (object): Information about the recipient.
       • name (string): The recipient's name.
       • phone (string): The recipient's phone number.
     • content (string): The content of the text message.
   • Return Value: Confirmation of message sending, including ID and status.

2. sendTemplateMessage

   • Send a template message to WhatsApp.
   • Required Inputs:
     • recipient (object): Information about the recipient.
       • name (string): The recipient's name.
       • phone (string): The recipient's phone number.
     • templateName (string): The name of the template to use.
     • templateValues (object): The values for placeholders in the template.
   • Return Value: Confirmation of template message sending, including ID and status.

3. sendInteractiveMessage

   • Send an interactive message to WhatsApp.
   • Required Inputs:
     • recipient (object): Information about the recipient.
       • name (string): The recipient's name.
       • phone (string): The recipient's phone number.
     • content (string): The content of the interactive message.
     • buttons (array): An array of buttons in the message.
       • Each button object must contain:
         • type (string): Should be of type "reply".
         • reply (object): Contains:
           • id (string): The ID of the reply button.
           • title (string): The title of the reply button.
   • Return Value: Confirmation of interactive message sending, including ID and status.

📦 Installation

1. Clone the Repository Use the following command to clone this repository to your local machine:

   git clone https://github.com/yourusername/gallabox-mcp-server.git
   

2. Install Dependencies Navigate to the project directory and install the required dependencies:

   cd gallabox-mcp-server
   yarn
   

📚 Documentation

Claude Desktop Configuration

To run the Gallabox MCP server on Claude Desktop, you need to configure the claude_desktop_config.json file. Here is an example configuration:

{
  "mcpServers": {
    "whatsapp": {
      "command": "npx",
      "args": ["-y", "/Users/navayuvan/Works/gallabox-mcp-server"],
      "env": {
        "CHANNEL_ID": "<your_channel_id>",
        "GALLABOX_API_KEY": "<your_api_key>",
        "GALLABOX_API_SECRET": "<your_api_secret>"
      }
    }
  }
}

After configuring, restart Claude Desktop.

Configuration Explanation

• command: The command to execute the server, using npx to run local packages.
• args: The arguments passed to the command, specifying the path to the Gallabox MCP server.
• env: The environment variables required for the server to run, including API credentials and the channel ID.