Voipbin MCP

🚀 語音-over-IP 模型上下文協議 (VoIP) 服務器

語音-over-IP 模型上下文協議 (VoIP MCP) 服務器是一款強大的工具，可管理和執行與語音-over-IP 相關的任務。它通過模型上下文協議與外部系統通信，支持呼叫管理、代理管理等多種功能。

🚀 快速開始

語音-over-IP 模型上下文協議 (VoIP MCP) 服務器是用於管理和執行與語音-over-IP 相關任務的工具。它通過模型上下文協議與外部系統通信，支持多種功能模塊。

✨ 主要特性

• 多平臺兼容性：支持在不同操作系統上運行。
• 高可用性：採用容錯設計，確保長時間穩定運行。
• 可擴展性：易於添加新的功能模塊和工具。
• 安全性：內置安全機制，防止未經授權的訪問。

📦 安裝指南

本地開發環境搭建

1. 安裝依賴

pip install -r requirements.txt

2. 啟動服務器

python server.py

Docker 部署

1. 構建鏡像

FROM python:3.9-slim
WORKDIR /app
COPY . .
RUN pip install --no-cache-dir -r requirements.txt
EXPOSE 5000
CMD ["python", "server.py"]

2. 運行容器

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 憑證
• 網絡連接問題
• 無效請求參數
• 被限流
• 服務器端錯誤

開發指南

添加新工具

1. 在 list_tools() 函數中註冊新工具。
2. 實現對應的處理函數。
3. 更新相關文檔。

測試

運行測試套件：

pytest tests/

安全注意事項

• 憑據保護：API 憑證通過環境變量存儲。
• 身份驗證：所有請求均需認證。
• 加密通信：強制使用 HTTPS 進行 API 通信。
• 輸入驗證：對所有用戶輸入進行嚴格驗證。

貢獻指南

1. Fork 項目倉庫。
2. 創建功能分支。
3. 提交代碼並推送至遠程倉庫。
4. 提交 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.

⚠️ 重要提示

本文檔內容僅供參考，作者不對因使用本軟件而產生的任何直接、間接、附帶、特殊、示範性或後果性的損害承擔責任。請在使用前仔細閱讀相關法律條款。