article
README
🚀 Twilio MCP 服务器
Twilio 的 MCP(MCP 协议)服务器是一款强大的工具,可与 Claude 桌面集成。它为开发者提供了丰富的 API 和功能,能简化支付处理、语音通话及其他通信相关任务。本文档将详细介绍该服务器的功能、使用方法和配置细节。
🚀 快速开始
要手动启动 MCP 服务器进行测试,请运行以下命令:
# 使用实际凭证运行
node build/index.js "your_account_sid_here" "your_api_key_here" "your_api_secret"
# 或使用 npm 脚本(开发环境)
npm run dev -- "your_account_sid_here" "your_api_key_here" "your_api_secret"
当在 Claude 桌面中使用时,服务器会自动启动。
✨ 主要特性
1. 支付处理
- 支付会话创建:提供
createPaymentSession方法来初始化新的支付会话。 - 支付信息捕获:提供
capturePaymentInfo方法来收集和处理用户支付信息。 - 支付状态查询:提供
getPaymentStatus方法来获取特定支付会话的状态。
2. 语音通信
- 通话连接:提供
connectCall方法来建立新的通话连接。 - 呼叫转移:提供
forwardCall方法将传入的呼叫转移到指定号码。 - 媒体处理:支持通过 Twilio 的 Media API 处理音频和视频流。
3. 日志记录
- 事件驱动日志记录架构:所有工具和资源类均继承自 Node.js 的
EventEmitter,并 emits 'log' 事件以记录操作。 - 日志级别支持:支持以下日志级别:info、error、debug 和 warn(自动转换为 info 级别)。
4. 回调数据处理
- 初始连接器数据:当支付会话首次创建时,Twilio 发送连接器数据。
- 捕获数据更新:在支付信息被捕获时,Twilio 发送更新的回调数据。
💻 使用示例
基础用法
初始化服务器
# 使用实际凭证运行
node build/index.js "your_account_sid_here" "your_api_key_here" "your_api_secret"
# 或使用 npm 脚本(开发环境)
npm run dev -- "your_account_sid_here" "your_api_key_here" "your_api_secret"
日志记录规范
// 工具日志的事件监听
startPaymentCaptureTool.on(LOG_EVENT, logToMcp);
captureCardNumberTool.on(LOG_EVENT, logToMcp);
// 其他工具...
支付回调数据结构
初始连接器数据
{
"PaymentConnector": "PGP_MOCK",
"DateCreated": "2021-08-10T03:55:53.408Z",
"PaymentMethod": "credit-card",
"CallSid": "CAzzzzz",
"ChargeAmount": "100.00",
"Currency": "USD"
}
捕获数据更新
{
"PaymentStatus": "captured",
"Amount": "100.00",
"TransactionId": "ABC123DEF"
}
错误日志示例
{
"error": {
"code": "401 Unauthorized",
"message": "Invalid authentication credentials"
}
}
📚 详细文档
兼容性说明
与 MCP 检查工具兼容性
- 日志级别处理:自动将 'warn' 级别转换为 'info' 级别。
安全注意事项
- PCI 合规性:服务器遵循 PCI 标准,确保支付信息的安全存储和传输。
- 凭证管理:建议使用环境变量或安全的凭证管理系统来存储敏感信息。
错误处理
常见错误
- 无效凭证:确保提供的 Account SID、API Key 和 Secret 是有效的 Twilio 凭证。
- 网络问题:检查服务器和 Twilio 服务之间的网络连接是否正常。
🔧 技术细节
日志记录
- 事件驱动日志记录系统:所有工具和资源类均继承自 Node.js 的
EventEmitter并 emits 'log' 事件。 - 日志转发:这些事件被捕获并转发到 MCP 服务器的日志系统。
总结
Twilio 的 MCP 服务器是一个功能强大且灵活的工具,能够帮助开发者高效地处理支付和通信相关任务。通过遵循本文档中的指南,您可以轻松集成和配置该服务器以满足各种需求。
微信扫一扫