Transport Department Puducherry

🚀 MCP Server

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

🚀 クイックスタート

このMCPサーバーを使用することで、指定されたOpenAPI URLに対応したサーバー機能を利用できます。以下の手順に従ってセットアップしましょう。

✨ 主な機能

• 指定されたOpenAPI URLに対応したMCPサーバーを提供します。
• 異なるトランスポートモード（stdio、sse、streamable-httpなど）をサポートしています。
• ruffによるコードのリントとフォーマット、mypyによる静的型チェック、pytestによるテストを行えます。

📦 インストール

前提条件

• 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ファイルは、テスト用にサーバーをプログラムで起動して対話する方法を示しています。

📚 ドキュメント

開発に関する情報

このプロジェクトは、コードのリントとフォーマットに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

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

ビルドと公開

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

プロジェクトをビルドするには：

hatch build

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

hatch publish

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