The Punjab State Board Of Technical Education Industrial Training

🚀 MCP Server

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

🚀 クイックスタート

このセクションでは、MCP Serverを迅速にセットアップし、実行するための基本的な手順を説明します。

✨ 主な機能

• 指定された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]"
   

📚 ドキュメント

開発に関する情報

リントとフォーマット

リントの問題をチェックするには:

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

ビルドと公開

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

hatch build

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

hatch publish

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