@akson/mcp-chatsuite
v1.0.1
Published
MCP server for ChatSuite WhatsApp automation platform
Downloads
10
Maintainers
Readme
ChatSuite MCP Server
A Model Context Protocol (MCP) server that provides Claude with access to the ChatSuite WhatsApp automation platform. This server enables Claude to manage WhatsApp sessions, send messages, manage groups, handle business features, and more.
Features
Session Management
- Create, list, and manage WhatsApp sessions
- Initialize sessions and generate QR codes
- Reset and delete sessions
Messaging
- Send text and media messages
- List and search messages
- Delete messages (including "delete for everyone")
- Quote/reply to messages
- Send reactions
Chat Management
- List and manage chats
- Mark chats as read
- Show typing indicators
- Clear chat history
Group Management
- Create and manage groups
- Add/remove participants
- Promote/demote admins
- Generate and revoke invite links
Interactive Messages
- Send button messages
- Send list messages
- Create polls
- Send contacts and locations
Business Features
- Create and manage product catalogs
- Handle orders
- Request payments
- Send order details
Status Updates
- Post text, image, and video status updates
- List and manage status updates
- View status viewers
API Token Management
- Create and manage API tokens
- Set granular permissions
- Revoke tokens
Installation
Prerequisites
- Node.js 18+ installed
- A ChatSuite account with API access
- An API token from ChatSuite
Install from npm
npm install -g @akson/mcp-chatsuiteInstall from source
git clone https://github.com/yourusername/mcp-chatsuite-server.git
cd mcp-chatsuite-server
npm install
npm run build
npm linkConfiguration
1. Set Environment Variables
Create environment variables for your ChatSuite credentials:
export CHATSUITE_API_URL=https://api.chatsuite.akson.ch
export CHATSUITE_API_TOKEN=wa_your_token_hereYou can also create a .env file in your home directory:
# ~/.env
CHATSUITE_API_URL=https://api.chatsuite.akson.ch
CHATSUITE_API_TOKEN=wa_your_token_here2. Configure Claude Desktop
Add the ChatSuite server to your Claude Desktop configuration:
macOS
Edit ~/Library/Application Support/Claude/claude_desktop_config.json:
{
"mcpServers": {
"chatsuite": {
"command": "mcp-chatsuite",
"env": {
"CHATSUITE_API_URL": "https://api.chatsuite.akson.ch",
"CHATSUITE_API_TOKEN": "wa_your_token_here"
}
}
}
}Windows
Edit %APPDATA%\Claude\claude_desktop_config.json:
{
"mcpServers": {
"chatsuite": {
"command": "mcp-chatsuite",
"env": {
"CHATSUITE_API_URL": "https://api.chatsuite.akson.ch",
"CHATSUITE_API_TOKEN": "wa_your_token_here"
}
}
}
}3. Restart Claude Desktop
After updating the configuration, restart Claude Desktop to load the ChatSuite server.
Usage
Once configured, you can use ChatSuite tools in Claude by asking it to:
- "List my WhatsApp sessions"
- "Send a WhatsApp message to +1234567890"
- "Create a new WhatsApp group called 'Team Updates'"
- "Show me unread chats"
- "Create a product catalog for my business"
- "Send a poll asking about meeting times"
Available Tools
Session Management
chatsuite_health- Check API healthchatsuite_list_sessions- List all sessionschatsuite_create_session- Create new sessionchatsuite_get_session- Get session details and QR codechatsuite_initialize_session- Initialize sessionchatsuite_reset_session- Reset sessionchatsuite_delete_session- Delete session
Messaging
chatsuite_send_message- Send text or media messagechatsuite_list_messages- List messages with filterschatsuite_delete_message- Delete message
Chat Management
chatsuite_list_chats- List chatschatsuite_get_chat- Get chat detailschatsuite_mark_as_read- Mark chat as readchatsuite_send_typing- Show typing indicator
Group Management
chatsuite_create_group- Create groupchatsuite_list_groups- List groupschatsuite_add_participants- Add participantschatsuite_remove_participant- Remove participantchatsuite_update_participant_role- Promote/demote admin
Interactive Messages
chatsuite_send_buttons- Send button messagechatsuite_send_list- Send list messagechatsuite_send_poll- Send pollchatsuite_send_location- Send locationchatsuite_send_contact- Send contactchatsuite_send_reaction- Send reaction
Business Features
chatsuite_create_catalog- Create product catalogchatsuite_create_order- Create orderchatsuite_request_payment- Request payment
Status Updates
chatsuite_post_status- Post status updatechatsuite_list_status- List status updates
Token Management
chatsuite_list_tokens- List API tokenschatsuite_create_token- Create API tokenchatsuite_revoke_token- Revoke API token
API Token Permissions
When creating API tokens for use with this MCP server, ensure they have the necessary permissions:
messaging:read- Required for reading messages, chats, and sessionsmessaging:write- Required for sending messages and managing sessions
Admin role is required for token management operations.
Troubleshooting
Server not connecting
- Check that your API token is valid
- Verify the API URL is correct
- Ensure Claude Desktop is properly restarted
- Check Claude Desktop logs for errors
Permission errors
- Verify your API token has the required permissions
- For admin operations, ensure your token has admin role
- Check the ChatSuite dashboard for token status
Connection issues
- Check your internet connection
- Verify the ChatSuite API is accessible
- Try the health check endpoint directly:
curl https://api.chatsuite.akson.ch/health
Development
Running locally
# Install dependencies
npm install
# Run in development mode
npm run dev
# Build for production
npm run buildTesting with Claude Desktop
- Build the project:
npm run build - Update Claude Desktop config to point to local build:
{ "mcpServers": { "chatsuite-dev": { "command": "node", "args": ["/path/to/mcp-chatsuite-server/dist/index.js"], "env": { "CHATSUITE_API_URL": "https://api.chatsuite.akson.ch", "CHATSUITE_API_TOKEN": "wa_your_token_here" } } } }
Security
- Never commit API tokens to version control
- Use environment variables for sensitive data
- Rotate API tokens regularly
- Use tokens with minimal required permissions
- Consider using separate tokens for development and production
Support
For issues with:
- ChatSuite API: Contact ChatSuite support
- MCP Server: Open an issue on GitHub
- Claude Desktop: Check Anthropic documentation
License
MIT
