本项目是一个 MCP 服务器,主要用于借助 Twilio API 发送 SMS 消息。它提供了一系列工具、资源和使用提示,方便用户与 Twilio 消息 API 进行交互。
在使用本服务器之前,你需要满足以下先决条件:
@deshartman/mcp-status-callback
)。你可以选择使用 npm 进行安装:
npm install @deshartman/twilio-messaging-mcp-server
或者直接通过 npx 运行:
npx @deshartman/twilio-messaging-mcp-server
无需安装,直接使用 npx 执行包:
# 使用所需参数运行
npx @deshartman/twilio-messaging-mcp-server
# 结合环境变量使用 ngrok
env NGROK_AUTH_TOKEN=your_token NGROK_CUSTOM_DOMAIN=your_domain.ngrok.dev npx @deshartman/twilio-messaging-mcp-server
这可以实现,因为包的 package.json 中包含 "bin" 字段,使其可通过 npx 执行。
你可以使用提供的脚本并通过 .env
文件运行:
# 创建一个 .env 文件,包含你的凭证
# 查看 .env.example 以获取所需格式
# 启动服务器(无需参数)
./run-server.sh
.env
文件应包含以下内容:
ACCOUNT_SID=YOUR_ACCOUNT_SID
API_KEY=YOUR_API_KEY
API_SECRET=YOUR_API_SECRET
TWILIO_NUMBER=YOUR_TWILIO_PHONE_NUMBER
NGROK_AUTH_TOKEN=YOUR_NGROK_AUTH_TOKEN
NGROK_CUSTOM_DOMAIN=your-domain.ngrok.dev
这种做法可以提高安全性,避免将凭证暴露在命令历史中,并简化执行过程。
env NGROK_AUTH_TOKEN=your_ngrok_auth_token NGROK_CUSTOM_DOMAIN=your_domain.ngrok.dev node build/index.js
此服务器提供了以下 MCP 功能:
send-sms
:通过 Twilio 发送 SMS 消息,带有服务器就绪验证。twilio://statuscallback
:获取 Twilio 的最后一个原始状态回调数据,并进行增强错误处理。SendSMS
:用于提示发送 SMS 使用 Twilio Messaging MCP 服务器的提示。如果你遇到以下错误:
failed to start tunnel: The endpoint 'https://your-domain.ngrok.dev' is already online.
你可以尝试以下方法之一:
--pooling-enabled
进行负载均衡。如果你遇到 npm 错误:
ENOTEMPTY Error: rmdir /path/to/directory
请确保目标目录为空,或者手动删除该目录后重试。这通常是因为 npm 在卸载包时失败导致的。
这个 MCP 服务器为通过 Twilio 发送 SMS 消息提供了强大的工具和集成能力,支持状态回调处理,并且可以通过 npx 轻松运行。希望以上文档能帮助你顺利完成配置和使用!