Shipengine Api

🚀 MCP Server

本项目是一个MCP（模型上下文协议）服务器，针对给定的OpenAPI URL - https://api.apis.guru/v2/specs/shipengine.com/1.1.202303022103/openapi.json ，使用AG2的 MCP构建器 自动生成。

🚀 快速开始

本项目的MCP服务器可以帮助你基于特定的OpenAPI URL进行相关操作，下面将详细介绍如何安装、开发、运行以及构建发布该项目。

✨ 主要特性

• 基于给定的OpenAPI URL自动生成MCP服务器。
• 支持多种运输模式，如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]"
   

💻 使用示例

开发相关

代码检查与格式化

要检查代码的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 脚本执行。