Twilio Frontline

🚀 MCP Server

This project is an MCP (Model Context Protocol) Server designed for the specified OpenAPI URL - https://api.apis.guru/v2/specs/twilio.com/twilio_frontline_v1/1.42.0/openapi.json. It is auto - generated using AG2's MCP builder, offering a reliable solution for handling model context protocols.

🚀 Quick Start

The MCP Server simplifies the process of working with the Model Context Protocol. It provides an efficient way to interact with the given OpenAPI URL, ensuring smooth operations and seamless integration.

✨ Features

• Auto - generated from AG2's MCP builder for the specific OpenAPI URL.
• Supports multiple transport modes such as stdio, sse, and streamable - http.
• Comes with a comprehensive set of development tools for linting, static analysis, and testing.
• Can be configured using environment variables for flexibility.

📦 Installation

Prerequisites

• Python 3.9+
• pip and uv

Steps

1. Clone the repository:

   git clone <repository-url>
   cd mcp-server
   

2. Install dependencies: The .devcontainer/setup.sh script handles dependency installation using pip install -e ".[dev]". If you're not using the dev container, run this command manually.

   pip install -e ".[dev]"
   

   Alternatively, use uv:

   uv pip install --editable ".[dev]"
   

💻 Usage Examples

Starting the Server

To start the server in stdio mode:

python mcp_server/main.py stdio

Configuring the Server

The server can be configured using environment variables:

• CONFIG_PATH: Path to a JSON configuration file (e.g., mcp_server/mcp_config.json).
• CONFIG: A JSON string containing the configuration.
• SECURITY: Environment variables for security parameters (e.g., API keys).

Refer to the if __name__ == "__main__": block in mcp_server/main.py for details on how these are loaded.

Testing the Server

The tests/test_mcp_server.py file demonstrates how to start and interact with the server programmatically for testing.

📚 Documentation

Development

Linting and Formatting

To check for linting issues:

ruff check

To format the code:

ruff format

These commands are also available via the scripts/lint.sh script.

Static Analysis

To run static analysis (mypy, bandit, semgrep):

./scripts/static-analysis.sh

This script is also configured as a pre - commit hook in .pre-commit-config.yaml.

Running Tests

To run tests with coverage:

./scripts/test.sh

This will run pytest and generate a coverage report. For a combined report and cleanup, you can use:

./scripts/test-cov.sh

Pre - commit Hooks

This project uses pre - commit hooks defined in .pre-commit-config.yaml. To install the hooks:

pre-commit install

The hooks will run automatically before each commit.

Building and Publishing

This project uses Hatch for building and publishing. To build the project:

hatch build

To publish the project:

hatch publish

These commands are also available via the scripts/publish.sh script.