The Punjab State Board Of Technical Education Industrial Training

🚀 MCP服務器

本項目是一個MCP（模型上下文協議）服務器，針對給定的OpenAPI URL - https://api.apis.guru/v2/specs/apisetu.gov.in/punjabteched/3.0.0/openapi.json ，使用AG2的 MCP構建器 自動生成。

🚀 快速開始

本項目是一個MCP（模型上下文協議）服務器，能依據指定的OpenAPI URL進行服務。藉助AG2的MCP構建器自動生成，為相關開發提供便利。

✨ 主要特性

• 基於給定的OpenAPI URL自動生成，適配特定的API規範。
• 支持多種運輸模式，如 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]"
   

💻 使用示例

基礎用法

啟動服務器

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 文件展示瞭如何以編程方式啟動和與服務器進行交互以進行測試。

📚 詳細文檔

代碼檢查和格式化

本項目使用 ruff 進行代碼檢查和格式化：

• 檢查代碼問題：

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 腳本執行。