Cloud Iot Api

🚀 MCP Server

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

🚀 快速開始

本 MCP 服務器可通過一系列步驟進行安裝、開發、運行、構建和發佈。下面將詳細介紹各個環節。

✨ 主要特性

• 針對特定 OpenAPI URL 自動生成 MCP 服務器。
• 支持多種傳輸模式，如 stdio、sse、streamable-http。
• 可通過環境變量進行靈活配置。
• 集成了代碼檢查、格式化、靜態分析和測試工具，保證代碼質量。

📦 安裝指南

克隆倉庫

git clone <repository-url>
cd mcp-server

安裝依賴

可以使用以下幾種方式安裝依賴：

• 使用 .devcontainer/setup.sh 腳本，它會使用 pip install -e ".[dev]" 來安裝依賴。若不使用開發容器，可手動運行此命令：

pip install -e ".[dev]"

• 也可以使用 uv：

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

💻 使用示例

開發相關操作

代碼檢查和格式化

• 檢查代碼的 linting 問題：

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