本项目是一个 MCP(模型上下文协议)服务器,针对给定的 OpenAPI URL - https://api.apis.guru/v2/specs/googleapis.com/cloudiot/v1/openapi.json ,使用 AG2 的 MCP 构建器 自动生成。
该 MCP 服务器可通过一系列步骤完成安装、开发、运行、构建和发布等操作,下面将详细介绍。
stdio、sse、streamable-http。git clone
cd mcp-server
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 脚本执行。