Voipbin MCP

🚀 Voice-over-IP Model Context Protocol (VoIP) Server

The Voice-over-IP Model Context Protocol (VoIP MCP) Server is a tool for managing and executing VoIP-related tasks, communicating with external systems via the model context protocol and supporting multiple functional modules.

🚀 Quick Start

The Voice-over-IP Model Context Protocol (VoIP MCP) server is a tool designed to manage and execute tasks related to Voice-over-IP. It communicates with external systems through the model context protocol and supports various functional modules, including call management, agent management, and chat message sending.

✨ Features

• Multi-platform Compatibility: Supports running on different operating systems.
• High Availability: Adopts a fault-tolerant design to ensure long-term stable operation.
• Scalability: Easily add new functional modules and tools.
• Security: Built-in security mechanisms to prevent unauthorized access.

📦 Installation

Local Development Environment Setup

1. Install Dependencies

   pip install -r requirements.txt
   

2. Start the Server

   python server.py
   

Docker Deployment

1. Build the Image

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

2. Run the Container

   docker build -t voip-mcp-server .
   docker run -p 5000:5000 voip-mcp-server
   

💻 Usage Examples

Basic Usage

Making a Call

{
  "name": "make_call",
  "arguments": {
    "phone_number": "+1234567890"
  }
}

Answering a Call

{
  "name": "answer_call",
  "arguments": {}
}

📚 Documentation

Functional Modules

Call Management

• Dialing
• Answering
• Transferring
• Hanging up

Agent Management

• Setting agent parameters
• Monitoring agent status
• Updating agent information

Chat Message Sending

• Sending text messages
• Sending rich text messages
• Managing chat records

Running the Server

Local Run

# Basic startup
python server.py

# Startup with a configuration file
python server.py --config config.json

Run in a Docker Container

docker exec -it voip-mcp-container python server.py

Tool Annotations

Each tool comes with metadata tags, including but not limited to:

• readOnlyHint: Identifies whether the tool only reads data.
• destructiveHint: Identifies whether the tool modifies or deletes data.
• idempotentHint: Identifies whether repeated calls have the same effect.
• openWorldHint: Identifies whether the tool runs in an open environment.

Error Handling

The server has a comprehensive built-in error handling mechanism, including but not limited to:

• Invalid API credentials
• Network connection issues
• Invalid request parameters
• Rate limiting
• Server-side errors

Development Guide

Adding a New Tool

1. Register the new tool in the list_tools() function.
2. Implement the corresponding handling function.
3. Update the relevant documentation.

Testing

Run the test suite:

pytest tests/

Security Precautions

• Credential Protection: API credentials are stored via environment variables.
• Authentication: All requests require authentication.
• Encrypted Communication: Force the use of HTTPS for API communication.
• Input Validation: Strictly validate all user input.

Contribution Guide

1. Fork the project repository.
2. Create a feature branch.
3. Commit the code and push it to the remote repository.
4. Submit a Pull Request.

Disclaimer

The content of this document is for reference only. The author is not liable for any direct, indirect, incidental, special, exemplary, or consequential damages arising from the use of this software. Please carefully read the relevant legal terms before use.

📄 License

This project is licensed under the MIT License. The full text is as follows:

MIT License

Copyright (c) [Year] [Author's Name]

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.