From 514385d969e2aa3c8edc0fb6bb9761dc9fe322eb Mon Sep 17 00:00:00 2001 From: creyes-clicksend Date: Thu, 14 Aug 2025 13:24:17 +0800 Subject: [PATCH 1/4] CDX-32 Updated README file --- README.md | 71 +++++++++++++++++++++++++++++++++++++++++++------------ 1 file changed, 56 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index c1159e2..103139d 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,21 @@ # ClickSend MCP Server -A Model Context Protocol (MCP) server that enables Claude and other AI assistants to send SMS and MMS messages using ClickSend. +**ClickSend MCP** refers to a Message Control Protocol (MCP) server developed specifically for **ClickSend**. +## Purpose -## Features - -- Send one SMS at a time by setting up the clicksend username and API Key -- Get Price for sending message to contact list -- Search Contacts or Contact Lists and send message to them -- Get SMS Templates, and use that to send message -- Get SMS Stastics for last 30 days +**ClickSend MCP is designed to extend ClickSend’s messaging capabilities into modern AI ecosystems and platforms** - allowing developers and AI agents (like GPTs and LangChain) to easily send SMS, and other messages via ClickSend—without needing to write custom code. + +This accelerates adoption, enables new AI-driven use cases, and positions ClickSend as a future-ready messaging platform in the age of intelligent automation. ## Requirements - Node.js >= 18 - you can use`nvm` (Node Version Manager) to set the right version to run this app +## Installation + +Download the Claude for desktop **[here](https://claude.ai/download)** ## Configuration @@ -24,15 +24,18 @@ The server requires two environment variables: - `CLICKSEND_USERNAME`: Your ClickSend username - `CLICKSEND_API_KEY`: Your ClickSend API Key -You can find the username and key at https://dashboard.clicksend.com/account/subaccounts once you Sign Up to ClickSend +You can find the username and key at https://dashboard.clicksend.com/account/subaccounts once you Sign Up to ClickSend. ### Claude Desktop Configuration -To use this server with Claude Desktop, add the following to your configuration file: +- Open Claude for Desktop +- Go to **Settings** from the system's menu bar +- In the settings window, navigate to the **Developer** tab and click **Edit Config**. + This opens the configuation file located at: -**macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json` + - **macOS**: `~/Library/Application Support/Claude/claude_desktop_config.json` -**Windows**: `%APPDATA%\Claude\claude_desktop_config.json` + - **Windows**: `%APPDATA%\Claude\claude_desktop_config.json` ```json { @@ -51,8 +54,7 @@ To use this server with Claude Desktop, add the following to your configuration } ``` -After that, restart Claude Desktop to reload the configuration. -If connected, you should see clicksend-send-sms when you click on the hammer icon +After that, restart Claude Desktop to reload the configuration. If connected, you should see clicksend-send-sms when you click on the hammer icon. ## Example Interactions with Claude @@ -63,13 +65,52 @@ Simple SMS: Send a text message to the number 61411111111 saying "I'm using ClickSend MCP server to sent SMS!" ``` +## Features + +- Send one SMS at a time by setting up the clicksend username and API Key +- Get Price for sending message to contact list +- Search Contacts or Contact Lists and send message to them +- Get SMS Templates, and use that to send message +- Get SMS Stastics for last 30 days + +## Supported APIs + +1. `POST /v3/sms/send` + - **Operation ID:** `send-sms` + - **Summary:** Send SMS + - **Description:** Send messages to recipients, either as phone numbers or contacts from a contact list. + +2. `POST /v3/sms/price` + - **Operation ID:** `calculate-sms-price` + - **Summary:** Calculate SMS Price + - **Description:** Calculate the price of sending messages based on message type and length. + +3. `GET /v3/sms/templates` + - **Operation ID:** `view-sms-templates` + - **Summary:** View SMS Templates + - **Description:** Retrieve SMS templates with filtering options. + +4. `GET /v3/sms/history` + - **Operation ID:** `view-sms-history` + - **Summary:** View SMS History + - **Description:** View previously sent SMS with filtering and pagination options. + +5. `GET /v3/statistics/sms` + - **Operation ID:** `view-sms-statistics` + - **Summary:** View SMS Statistics + - **Description:** Get SMS statistics for the last 30 days. + +6. `GET /v3/search/contacts-lists` + - **Operation ID:** `view-contact-lists` + - **Summary:** View Contact Lists + - **Description:** Get a list of searched contact lists. + ## Important Notes 1. **Phone Number Format**: All phone numbers must be in E.164 format (e.g., +61411111111) 2. **Rate Limits**: Be aware of your ClickSend account's rate limits and pricing 3. **Security**: Keep your ClickSend credentials secure and never commit them to version control - ## Troubleshooting Common error messages and solutions: From fa14ce5241539c917a916a4bdaab1d5e4f1729e2 Mon Sep 17 00:00:00 2001 From: creyes-clicksend Date: Thu, 14 Aug 2025 13:28:17 +0800 Subject: [PATCH 2/4] CDX-32 Updated typo --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 103139d..1351264 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ This accelerates adoption, enables new AI-driven use cases, and positions ClickS ## Installation -Download the Claude for desktop **[here](https://claude.ai/download)** +Download the Claude for desktop **[here](https://claude.ai/download)**. ## Configuration @@ -71,7 +71,7 @@ Send a text message to the number 61411111111 saying "I'm using ClickSend MCP se - Get Price for sending message to contact list - Search Contacts or Contact Lists and send message to them - Get SMS Templates, and use that to send message -- Get SMS Stastics for last 30 days +- Get SMS Statistics for last 30 days ## Supported APIs From 83526cf915ec5cb24249699ce7023f6383ffa2a1 Mon Sep 17 00:00:00 2001 From: creyes-clicksend Date: Thu, 14 Aug 2025 13:53:08 +0800 Subject: [PATCH 3/4] CDX-32 Updated Features --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 1351264..6014aba 100644 --- a/README.md +++ b/README.md @@ -71,6 +71,7 @@ Send a text message to the number 61411111111 saying "I'm using ClickSend MCP se - Get Price for sending message to contact list - Search Contacts or Contact Lists and send message to them - Get SMS Templates, and use that to send message +- View/Retrieve SMS history - Get SMS Statistics for last 30 days ## Supported APIs From 58e32b3c76082438d00824f5130c82d3b1b2ed0f Mon Sep 17 00:00:00 2001 From: creyes-clicksend Date: Fri, 15 Aug 2025 12:48:32 +0800 Subject: [PATCH 4/4] CDX-32 Updated based on PR comments --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6014aba..dc69299 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # ClickSend MCP Server -**ClickSend MCP** refers to a Message Control Protocol (MCP) server developed specifically for **ClickSend**. +This is the official **ClickSend MCP Server** developed by the ClickSend team. For security reasons do not use unofficial versions of ClickSend MCP. ## Purpose -**ClickSend MCP is designed to extend ClickSend’s messaging capabilities into modern AI ecosystems and platforms** - allowing developers and AI agents (like GPTs and LangChain) to easily send SMS, and other messages via ClickSend—without needing to write custom code. +**ClickSend MCP is designed to extend ClickSend’s messaging capabilities into modern AI ecosystems and platforms** - allowing developers to easily send SMS via ClickSend without needing to write custom code. This accelerates adoption, enables new AI-driven use cases, and positions ClickSend as a future-ready messaging platform in the age of intelligent automation. @@ -15,7 +15,7 @@ This accelerates adoption, enables new AI-driven use cases, and positions ClickS ## Installation -Download the Claude for desktop **[here](https://claude.ai/download)**. +Download an AI desktop client. An example would be Claude for Desktop which you can download **[here](https://claude.ai/download)**. ## Configuration