Xtrf Home Portal Api

🚀 MCP Server

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

🚀 クイックスタート

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

✨ 主な機能

• 指定されたOpenAPI URLに対応したMCPサーバーを提供します。
• さまざまなトランスポートモード（stdio, sse, streamable-http）をサポートします。
• ruffによるコードのlintingとformatting、mypyによる静的型チェック、pytestによるテストをサポートします。

📦 インストール

前提条件

• Python 3.9+
• pipとuv

手順

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

   git clone <repository-url>
   cd mcp-server
   

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

   pip install -e ".[dev]"
   

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

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

💻 使用例

基本的な使用法

サーバーを起動するには、mcp_server/main.py スクリプトを使用します。例えば、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__": ブロックを参照してください。

📚 ドキュメント

開発に関する情報

LintingとFormatting

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

ruff check

コードを整形するには：

ruff format

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

静的解析

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

./scripts/static-analysis.sh

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

テストの実行

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

./scripts/test.sh

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

./scripts/test-cov.sh

Pre-commitフック

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

pre-commit install

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

ビルドと公開

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

hatch build

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

hatch publish

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