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 脚本执行。