Xtrf Home Portal Api

🚀 MCP服務器

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

🚀 快速開始

前提條件

• 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 進行代碼檢查和格式化，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 腳本來啟動MCP服務器。它支持不同的傳輸模式（例如，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 腳本執行。