@peachai/mcp 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +107 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
# @peachai/mcp
|
|
2
|
+
|
|
3
|
+
MCP (Model Context Protocol) server for the [Peach](https://trypeach.io) WhatsApp messaging platform. Lets AI assistants like Claude send messages, manage templates, contacts, and media directly through your Peach account.
|
|
4
|
+
|
|
5
|
+
## Requirements
|
|
6
|
+
|
|
7
|
+
- Node.js 18 or higher
|
|
8
|
+
- A Peach account with an API key
|
|
9
|
+
|
|
10
|
+
## Getting your API key
|
|
11
|
+
|
|
12
|
+
Log in to [app.trypeach.io](https://app.trypeach.io), go to **Settings → API**, and copy your API key.
|
|
13
|
+
|
|
14
|
+
## Setup
|
|
15
|
+
|
|
16
|
+
### Claude Desktop
|
|
17
|
+
|
|
18
|
+
Add the following to your `claude_desktop_config.json`:
|
|
19
|
+
|
|
20
|
+
**macOS:** `~/Library/Application Support/Claude/claude_desktop_config.json`
|
|
21
|
+
**Windows:** `%APPDATA%\Claude\claude_desktop_config.json`
|
|
22
|
+
|
|
23
|
+
```json
|
|
24
|
+
{
|
|
25
|
+
"mcpServers": {
|
|
26
|
+
"peach": {
|
|
27
|
+
"command": "npx",
|
|
28
|
+
"args": ["-y", "@peachai/mcp"],
|
|
29
|
+
"env": {
|
|
30
|
+
"PEACH_API_KEY": "your-api-key"
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
Restart Claude Desktop. You should see the Peach tools available in your conversation.
|
|
38
|
+
|
|
39
|
+
### Cursor
|
|
40
|
+
|
|
41
|
+
Go to **Settings → MCP** and add:
|
|
42
|
+
|
|
43
|
+
```json
|
|
44
|
+
{
|
|
45
|
+
"peach": {
|
|
46
|
+
"command": "npx",
|
|
47
|
+
"args": ["-y", "@peachai/mcp"],
|
|
48
|
+
"env": {
|
|
49
|
+
"PEACH_API_KEY": "your-api-key"
|
|
50
|
+
}
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
## Available tools
|
|
56
|
+
|
|
57
|
+
### Messaging
|
|
58
|
+
| Tool | Description |
|
|
59
|
+
|------|-------------|
|
|
60
|
+
| `peach_send_template_message` | Send a WhatsApp template message to a contact |
|
|
61
|
+
| `peach_send_app_message` | Trigger a flow or app-initiated message |
|
|
62
|
+
| `peach_connect_to_ai_agent` | Send a template and connect the contact to an AI agent |
|
|
63
|
+
| `peach_get_event_status` | Check the status of a sent event |
|
|
64
|
+
| `peach_list_template_messages` | List sent template messages with filters |
|
|
65
|
+
|
|
66
|
+
### Broadcasts
|
|
67
|
+
| Tool | Description |
|
|
68
|
+
|------|-------------|
|
|
69
|
+
| `peach_launch_broadcast` | Create and launch a broadcast campaign |
|
|
70
|
+
|
|
71
|
+
### Templates
|
|
72
|
+
| Tool | Description |
|
|
73
|
+
|------|-------------|
|
|
74
|
+
| `peach_list_templates` | List all WhatsApp templates |
|
|
75
|
+
| `peach_get_template` | Get a specific template by ID or name |
|
|
76
|
+
| `peach_create_template` | Create a new WhatsApp template |
|
|
77
|
+
| `peach_update_template` | Update an existing template |
|
|
78
|
+
| `peach_submit_template` | Submit a template for Meta review |
|
|
79
|
+
| `peach_pause_template` | Pause an approved template |
|
|
80
|
+
| `peach_archive_template` | Archive a template |
|
|
81
|
+
|
|
82
|
+
### Contacts
|
|
83
|
+
| Tool | Description |
|
|
84
|
+
|------|-------------|
|
|
85
|
+
| `peach_create_contact` | Create or upsert a single contact |
|
|
86
|
+
| `peach_create_contacts` | Bulk create or upsert contacts |
|
|
87
|
+
| `peach_update_contact` | Update a contact by phone number |
|
|
88
|
+
|
|
89
|
+
### Media
|
|
90
|
+
| Tool | Description |
|
|
91
|
+
|------|-------------|
|
|
92
|
+
| `peach_list_media` | List uploaded media files |
|
|
93
|
+
| `peach_upload_media` | Upload a media file (base64) |
|
|
94
|
+
| `peach_delete_media` | Delete a media file |
|
|
95
|
+
|
|
96
|
+
### Messages
|
|
97
|
+
| Tool | Description |
|
|
98
|
+
|------|-------------|
|
|
99
|
+
| `peach_list_messages` | List messages with optional filters |
|
|
100
|
+
|
|
101
|
+
## Example prompts
|
|
102
|
+
|
|
103
|
+
- *"Send the order_confirmation template to +14155552671 with order ID 12345"*
|
|
104
|
+
- *"Create a new MARKETING template called summer_sale with a body saying 'Get 20% off this weekend!'"*
|
|
105
|
+
- *"List all my approved WhatsApp templates"*
|
|
106
|
+
- *"Update the contact +14155552671's name to John Smith"*
|
|
107
|
+
- *"Launch a broadcast using template promo_v2 to audience list abc123"*
|