Cloud Filestore Api

🚀 MCP Server

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

🚀 クイックスタート

このMCPサーバーを使用する前に、いくつかの前提条件を満たす必要があります。また、インストール、開発、サーバーの実行、ビルドと公開の手順があります。以下に詳細を説明します。

✨ 主な機能

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

📦 インストール

前提条件

• 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_server/main.py スクリプトを使用します。例えば、stdio モードでサーバーを起動するには、以下のコマンドを実行します：

python mcp_server/main.py stdio

高度な使用法

サーバーは環境変数を使用して設定できます。例えば、JSON設定ファイルのパスを指定するには、CONFIG_PATH 環境変数を使用します。

export CONFIG_PATH=mcp_server/mcp_config.json
python mcp_server/main.py stdio

📚 ドキュメント

開発

このプロジェクトでは、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

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

サーバーの実行

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

サーバーは環境変数を使用して設定できます：

• 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 スクリプトを通じても利用できます。