🚀 语音-over-IP 模型上下文协议 (VoIP) 服务器
语音-over-IP 模型上下文协议 (VoIP MCP) 服务器是一款强大的工具，可管理和执行与语音-over-IP 相关的任务。它通过模型上下文协议与外部系统通信，支持呼叫管理、代理管理等多种功能。
🚀 快速开始
语音-over-IP 模型上下文协议 (VoIP MCP) 服务器是用于管理和执行与语音-over-IP 相关任务的工具。它通过模型上下文协议与外部系统通信，支持多种功能模块。
✨ 主要特性
- 多平台兼容性：支持在不同操作系统上运行。
- 高可用性：采用容错设计，确保长时间稳定运行。
- 可扩展性：易于添加新的功能模块和工具。
- 安全性：内置安全机制，防止未经授权的访问。
📦 安装指南
本地开发环境搭建
- 安装依赖
pip install -r requirements.txt
- 启动服务器
python server.py
Docker 部署
- 构建镜像
FROM python:3.9-slim
WORKDIR /app
COPY . .
RUN pip install --no-cache-dir -r requirements.txt
EXPOSE 5000
CMD ["python", "server.py"]
- 运行容器
docker build -t voip-mcp-server .
docker run -p 5000:5000 voip-mcp-server
💻 使用示例
基础用法
拨号
{
"name": "make_call",
"arguments": {
"phone_number": "+1234567890"
}
}
接听呼叫
{
"name": "answer_call",
"arguments": {}
}
📚 详细文档
功能模块
呼叫管理 (Call Management)
- 拨号
- 接听
- 转接
- 挂断
代理管理 (Agent Management)
- 设置代理参数
- 监控代理状态
- 更新代理信息
聊天消息发送 (Chat Message Sending)
- 发送文本消息
- 发送富文本消息
- 管理聊天记录
运行服务器
本地运行
# 基本启动
python server.py
# 带配置文件的启动
python server.py --config config.json
Docker 容器内运行
docker exec -it voip-mcp-container python server.py
工具注释
每个工具都带有元数据标签，包括但不限于：
- readOnlyHint：标识工具是否仅读取数据。
- destructiveHint：标识工具是否修改或删除数据。
- idempotentHint：标识重复调用是否会带来相同效果。
- openWorldHint：标识工具是否在开放环境中运行。
错误处理
服务器内置全面的错误处理机制，包括但不限于：
- 无效 API 凭证
- 网络连接问题
- 无效请求参数
- 被限流
- 服务器端错误
开发指南
添加新工具
- 在
list_tools()函数中注册新工具。 - 实现对应的处理函数。
- 更新相关文档。
测试
运行测试套件：
pytest tests/
安全注意事项
- 凭据保护：API 凭证通过环境变量存储。
- 身份验证：所有请求均需认证。
- 加密通信：强制使用 HTTPS 进行 API 通信。
- 输入验证：对所有用户输入进行严格验证。
贡献指南
- Fork 项目仓库。
- 创建功能分支。
- 提交代码并推送至远程仓库。
- 提交 Pull Request。
📄 许可证
本项目遵循 MIT 协议，具体内容如下：
MIT License
Copyright (c) [年份] [作者姓名]
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
⚠️ 重要提示
本文档内容仅供参考，作者不对因使用本软件而产生的任何直接、间接、附带、特殊、示范性或后果性的损害承担责任。请在使用前仔细阅读相关法律条款。