Twilio Frontline

🚀 MCP Server

このプロジェクトは、指定されたOpenAPI URL - https://api.apis.guru/v2/specs/twilio.com/twilio_frontline_v1/1.42.0/openapi.json 用のMCP（Model Context Protocol）サーバーです。AG2の MCPビルダー を使用して自動生成されています。

🚀 クイックスタート

このMCPサーバーを使用するには、まず前提条件を満たし、インストールを行い、開発やサーバーの実行、ビルドと公開の手順に沿って進める必要があります。

✨ 主な機能

• 自動生成: AG2のMCPビルダーを使用して、指定されたOpenAPI URL用に自動生成されます。
• 複数のトランスポートモード: stdio、sse、streamable-http などの異なるトランスポートモードをサポートします。
• 環境変数による設定: サーバーを環境変数で設定することができます。

📦 インストール

前提条件

• Python 3.9+
• pipとuv

手順

1. リポジトリをクローンします:

   git clone <repository-url>
   cd mcp-server
   

2. 依存関係をインストールします: .devcontainer/setup.sh スクリプトは pip install -e ".[dev]" を使用して依存関係のインストールを処理します。開発コンテナを使用していない場合は、このコマンドを手動で実行することができます。

   pip install -e ".[dev]"
   

   あるいは、uv を使用することもできます:

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

💻 使用例

基本的な使用法

サーバーの起動

MCPサーバーは mcp_server/main.py スクリプトを使用して起動することができます。異なるトランスポートモード（例: stdio、sse、streamable-http）をサポートしています。

サーバーを起動するには（例: stdioモード）:

python mcp_server/main.py stdio

サーバーの設定

サーバーは環境変数を使用して設定することができます:

• CONFIG_PATH: JSON設定ファイルへのパス（例: mcp_server/mcp_config.json）。
• CONFIG: 設定を含むJSON文字列。
• SECURITY: セキュリティパラメータ（例: APIキー）の環境変数。

これらがどのように読み込まれるかの詳細については、mcp_server/main.py の if __name__ == "__main__": ブロックを参照してください。

テスト

tests/test_mcp_server.py ファイルは、テストのためにサーバーをプログラムで起動して対話する方法を示しています。

高度な使用法

ビルドと公開

このプロジェクトはHatchを使用してビルドと公開を行います。 プロジェクトをビルドするには:

hatch build

プロジェクトを公開するには:

hatch publish

これらのコマンドは scripts/publish.sh スクリプトを介しても利用できます。

📚 ドキュメント

開発

このプロジェクトは、コードの検査と整形に ruff を、静的型チェックに mypy を、テストに pytest を使用しています。

コードの検査と整形

コードの検査を行うには:

ruff check

コードを整形するには:

ruff format

これらのコマンドは scripts/lint.sh スクリプトを介しても利用できます。

静的解析

静的解析（mypy、bandit、semgrep）を実行するには:

./scripts/static-analysis.sh

このスクリプトは .pre-commit-config.yaml でプリコミットフックとしても設定されています。

テストの実行

カバレッジ付きでテストを実行するには:

./scripts/test.sh

これによりpytestが実行され、カバレッジレポートが生成されます。結合レポートとクリーンアップを行うには、次のコマンドを使用できます:

./scripts/test-cov.sh

プリコミットフック

このプロジェクトは .pre-commit-config.yaml で定義されたプリコミットフックを使用しています。フックをインストールするには:

pre-commit install

フックは各コミットの前に自動的に実行されます。