Open BSP API

v1.0.0โ€ขAPIsโ€ขstable

Open-source WhatsApp Business platform

agentsaiai-agentsdenomcp
Share:
310
Stars
0
Downloads
0
Weekly
0/5

What is Open BSP API?

Open BSP API is a Model Context Protocol (MCP) server that allows AI assistants like Claude, Cursor, and VS Code to open-source whatsapp business platform

Open-source WhatsApp Business platform

This server falls under the APIs category on MCPgee, the world's largest MCP server directory with 33,000+ servers.

Features

  • Open-source WhatsApp Business platform

Use Cases

WhatsApp Business platform integration
Messaging API for agents
WhatsApp automation
LicenseUnlicense
Languagetypescript
Versionv1.0.0
UpdatedMay 21, 2026
Statushealthy
Maintenanceactive

Works with

ClaudeOpenAIwindowsmacoslinux

Installation

Manual Installation

npx open-bsp-api

Configuration

Configuration Details

Config File

claude_desktop_config.json

Performance

Response Metrics

Response Time< 200ms
ThroughputMedium

Resource Usage

Memory UsageLow
CPU UsageLow

How to Set Up and Use Open BSP API

Open BSP API is an open-source WhatsApp Business Service Provider platform that enables AI agents to send and receive WhatsApp messages through a self-hosted, multi-tenant infrastructure. It deploys on Supabase Edge Functions and provides an MCP endpoint that exposes tools for listing accounts, browsing conversations, fetching message history, searching contacts, and sending text or template messages. Developers and businesses can use it to build WhatsApp-powered AI agents without relying on proprietary BSP vendors.

Prerequisites

  • A Supabase account and project (https://supabase.com)
  • A Meta Business account with a WhatsApp Business product enabled and a verified phone number
  • Meta app credentials: META_APP_ID, META_APP_SECRET, META_SYSTEM_USER_ID, META_SYSTEM_USER_ACCESS_TOKEN
  • Node.js and Docker (for local development)
  • An MCP-compatible AI client such as Claude for Desktop
1

Fork and connect the repository to Supabase

Fork the open-bsp-api repository on GitHub, then create a Supabase project and connect it to your fork using the Supabase GitHub Integration. Pushing to the main branch will trigger the initial deployment of Edge Functions automatically.

# Fork: https://github.com/matiasbattocchia/open-bsp-api
# Then connect at: https://supabase.com/dashboard/project/_/settings/integrations
2

Set Meta environment variables in Supabase

In your Supabase project dashboard, navigate to Settings > Edge Functions > Secrets and add the required Meta integration environment variables.

META_SYSTEM_USER_ID=your_system_user_id
META_SYSTEM_USER_ACCESS_TOKEN=your_access_token
META_APP_ID=your_app_id
META_APP_SECRET=your_app_secret
WHATSAPP_VERIFY_TOKEN=your_chosen_verify_token
3

Connect WhatsApp accounts via Embedded Signup

Use the Embedded Signup flow in your deployed instance to connect one or more WhatsApp Business phone numbers. Each connected account gets its own isolated tenant environment within the platform.

4

Configure the MCP endpoint in your AI client

The MCP server is available at the Supabase Edge Function URL. Add it to your claude_desktop_config.json using the streamable HTTP transport with your Supabase project URL.

{
  "mcpServers": {
    "open-bsp-api": {
      "type": "http",
      "url": "https://YOUR_PROJECT_ID.supabase.co/functions/v1/mcp",
      "headers": {
        "Authorization": "Bearer YOUR_SUPABASE_ANON_KEY"
      }
    }
  }
}
5

Verify connectivity by listing accounts

Use your AI client to call the list_accounts tool and confirm it returns the WhatsApp accounts you connected in the previous step.

Open BSP API Examples

Client configuration

MCP client config for connecting to a self-hosted Open BSP API instance deployed on Supabase.

{
  "mcpServers": {
    "open-bsp-api": {
      "type": "http",
      "url": "https://abcdefghijklmnop.supabase.co/functions/v1/mcp",
      "headers": {
        "Authorization": "Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
      }
    }
  }
}

Prompts to try

Use these prompts in your AI client to interact with WhatsApp through the Open BSP API MCP server.

- "List all connected WhatsApp accounts"
- "Show me the 10 most recent conversations"
- "Fetch the full message history for the conversation with +1-555-0100"
- "Search for a contact named Maria"
- "Send a WhatsApp message to +1-555-0101 saying 'Your order is ready for pickup'"
- "List available message templates for my account"

Troubleshooting Open BSP API

Edge Functions fail to deploy after pushing to GitHub

Check the Supabase dashboard under Edge Functions for deployment logs. Common causes are missing environment variables or a Supabase plan that does not support the required number of Edge Function invocations. Ensure all required secrets are set before the first push.

WhatsApp message sending returns a permission error from Meta

Verify that your META_SYSTEM_USER_ACCESS_TOKEN has the 'whatsapp_business_messaging' permission and is associated with the correct Meta app. System user tokens must be explicitly granted permissions in Meta Business Manager under the relevant WhatsApp Business Account.

MCP endpoint returns 401 Unauthorized

The Authorization header must contain a valid Supabase user JWT or the anon key, depending on how you configured the Edge Function security policy. Check your Supabase project's API settings to find the correct anon key and ensure Row Level Security policies allow access.

Frequently Asked Questions about Open BSP API

What is Open BSP API?

Open BSP API is a Model Context Protocol (MCP) server that open-source whatsapp business platform It connects AI assistants to external tools and data sources through a standardized interface.

How do I install Open BSP API?

Follow the installation instructions on the Open BSP API GitHub repository. Clone the repo, install dependencies, and add the server config to your AI client.

Which AI clients work with Open BSP API?

Open BSP API works with all major MCP-compatible AI clients including Claude Desktop, Claude Code, Cursor, VS Code (GitHub Copilot), Windsurf, and Cline.

Is Open BSP API free to use?

Yes, Open BSP API is open source and available under the Unlicense license. You can use it freely in both personal and commercial projects.

Browse More APIs MCP Servers

Explore all apis servers available in the MCPgee directory. Each server includes setup guides for Claude, Cursor, and VS Code.

Quick Config Preview

{ "mcpServers": { "open-bsp-api": { "command": "npx", "args": ["-y", "open-bsp-api"] } } }

Add this to your claude_desktop_config.json or .cursor/mcp.json

Read the full setup guide โ†’

Ready to use Open BSP API?

Browse our complete directory of 33,000+ MCP servers, read setup guides for your editor, and start building with the Model Context Protocol.

33,000+ ServersFree & Open SourceStep-by-Step Guides