Playable Locations Api

🚀 MCP Server

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

🚀 クイックスタート

このセクションでは、MCP Serverのセットアップと実行に必要な手順を説明します。

✨ 主な機能

• 指定されたOpenAPI URL用のMCPサーバーを提供します。
• 様々なトランスポートモード（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]"
   

💻 使用例

基本的な使用法

サーバーを起動するには、以下のコマンドを実行します（例：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__":ブロックを参照してください。

📚 ドキュメント

開発

このプロジェクトでは、コードの検査と整形に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スクリプトを介しても利用できます。