Cloud Iot Api

🚀 MCP Server

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

🚀 クイックスタート

このMCPサーバーは、特定のOpenAPI仕様に基づいて自動生成されたサーバーです。以下の手順でセットアップと実行が可能です。

✨ 主な機能

• 自動生成: AG2のMCPビルダーを使用して、指定されたOpenAPI URLから自動生成されます。
• 多様なトランスポートモード: stdio、sse、streamable-httpなどの異なるトランスポートモードをサポートします。
• 開発ツールのサポート: ruffによるコードのlintingとフォーマット、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__":ブロックを参照してください。

テストの実行

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

./scripts/test.sh

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

./scripts/test-cov.sh

📚 ドキュメント

開発におけるコードのチェックとフォーマット

Lintingチェック

lintingの問題をチェックするには:

ruff check

コードのフォーマット

コードをフォーマットするには:

ruff format

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

静的解析

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

./scripts/static-analysis.sh

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

プリコミットフック

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

pre-commit install

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

🔧 技術詳細

このプロジェクトでは、ruffをlintingとフォーマットに、mypyを静的型チェックに、pytestをテストに使用しています。また、開発環境ではuvを使用して依存関係をインストールできます。サーバーの起動には、mcp_server/main.pyスクリプトを使用し、異なるトランスポートモードをサポートしています。

📄 ライセンス

元のREADMEにライセンス情報が記載されていないため、このセクションは省略されています。