Promotexter MCP Server

Promotexter MCP服务器

用于与Promotexter SMS API集成的模型上下文协议（MCP）服务器。此服务器提供发送短信和检查账户余额的工具。

特性

• 余额查询：检查您当前的Promotexter账户余额，并提供详细信息（可用余额、账户余额、信用额度、扣缴金额）
• 单短信交易：向单个收件人发送短信

安装

使用pip

pip install promotexter-mcp

使用uvx（推荐）

uvx promotexter-mcp

快速开始

1.获取您的Promotorxter证书

您需要：

• API密钥
• API秘密
• 发件人ID（必须在您的Promoterxter帐户中列入白名单）

从您的Promotexter仪表板获取这些信息，网址为https://promotexter.com

2.设置环境变量

export PROMOTEXTER_API_KEY="your_api_key_here"
export PROMOTEXTER_API_SECRET="your_api_secret_here"
export PROMOTEXTER_SENDER_ID="your_sender_id_here"

或者创建一个 .env 文件：

PROMOTEXTER_API_KEY=your_api_key_here
PROMOTEXTER_API_SECRET=your_api_secret_here
PROMOTEXTER_SENDER_ID=your_sender_id_here

3.配置MCP客户端

适用于克劳德桌面

添加到MCP设置文件(~/Library/Application Support/Claude/claude_desktop_config.json 在macOS上）：

{
  "mcpServers": {
    "promotexter": {
      "command": "uvx",
      "args": ["promotexter-mcp"],
      "env": {
        "PROMOTEXTER_API_KEY": "your_api_key_here",
        "PROMOTEXTER_API_SECRET": "your_api_secret_here",
        "PROMOTEXTER_SENDER_ID": "your_sender_id_here"
      }
    }
  }
}

或者使用shell中的环境变量：

{
  "mcpServers": {
    "promotexter": {
      "command": "uvx",
      "args": ["promotexter-mcp"]
    }
  }
}

适用于Claude Code CLI

添加到MCP设置中：

{
  "mcpServers": {
    "promotexter": {
      "command": "uvx",
      "args": ["promotexter-mcp"],
      "env": {
        "PROMOTEXTER_API_KEY": "your_api_key_here",
        "PROMOTEXTER_API_SECRET": "your_api_secret_here",
        "PROMOTEXTER_SENDER_ID": "your_sender_id_here"
      }
    }
  }
}

可用工具

get_balance

从Promotexter获取当前账户余额。

参数： 无

退货：

• 可用余额
• 账户余额
• 信用额度
• 扣缴金额

例子：

get_balance()

答复：

Available Balance: 486
Account Balance: 486
Credit Limit: 0
Withheld: 0

send_sms

通过Promotexter发送一条短信。

参数：

• to （必填）：国际格式的收件人手机号码（例如63917000001）
• text （必填）：消息内容（最多1000个字符）
• reference_id （可选）：您自己的跟踪参考ID

注： 发件人ID是通过配置的 PROMOTEXTER_SENDER_ID 环境变量，并且必须在您的Promotexter帐户中列入白名单。

退货： 短信发送响应，其中包含交易详细信息，包括：

• 消息ID
• 剩余余额
• 交易成本
• 单位成本
• 消息零件计数
• 操作员代码
• 领取号码
• 寄件者身份
• 参考ID（如果提供）

例子：

send_sms(
    to="639170000001",
    text="Hello! This is a test message.",
    reference_id="test-001"
)

答复：

SMS Sent Successfully!
Message ID: abc123...
Remaining Balance: 485.50
Transaction Cost: 0.50
Unit Cost: 0.50
Message Parts: 1
Operator: PHLSMART
To: 639170000001
From: DEMO
Reference ID: test-001

发展

本地运行

1. 克隆存储库：

git clone https://github.com/johnalvero/promotexter-mcp.git
cd promotexter-mcp

1. 安装依赖项：

pip install -e .

1. 运行服务器：

python -m promotexter_mcp.server

MCP检验员测试

fastmcp dev promotexter_mcp/server.py

API文档

有关Promotexter API的更多信息，请访问：

• API文件：https://promotexter.docs.apiary.io/
• Promotexter网站：https://promotexter.com

安全说明

• 永远不要将您的API凭据提交到版本控制
• 使用环境变量或安全凭证管理系统
• 使用前，发件人ID必须在您的Promotorxter帐户中列入白名单
• 发送前确保正确验证收件人号码
• 在生产使用之前，在开发环境中进行彻底测试

错误处理

该服务器包括全面的错误处理功能，用于：

• 缺少或无效的凭据
• Promotexter API的HTTP错误
• 无效参数
• 网络超时
• 消息长度验证（最多1000个字符）
• 电话号码格式无效

需求

• Python 3.10或更高版本
• fastmcp>=2.13.0
• httpx>=0.27.0

许可证

MIT许可证-请参阅 许可证 详细信息文件

支持

关于以下问题：

• 此MCP服务器：打开一个问题https://github.com/johnalvero/promotexter-mcp/issues
• 推广人API：请通过以下方式联系Promoterxter支持https://promotexter.freshdesk.com/

贡献

欢迎投稿！请随时提交拉取请求。

更新日志

0.1.1 (2025-11-01)

• 更新了包含正确安装说明的文档
• 在配置示例中添加了uvx支持
• 通过详细的示例和响应改进了README
• 为更清洁的分销添加了套餐除外条款

0.1.0 (2025-11-01)

• 初始版本
• 余额查询工具
• 单短信交易工具
• 基于环境的配置
• 全面的错误处理