Shipengine Api

🚀 MCP Server

このプロジェクトは、指定されたOpenAPI URL - https://api.apis.guru/v2/specs/shipengine.com/1.1.202303022103/openapi.json 用のMCP（Model Context Protocol）サーバーです。AG2のMCPビルダーを使用して自動生成されています。

🚀 クイックスタート

このセクションでは、MCP Serverのセットアップと起動に必要な手順を説明します。

✨ 主な機能

• 指定された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]"
   

💻 使用例

基本的な使用法

サーバーの起動

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 ファイルは、テスト用にサーバーをプログラムで起動してやり取りする方法を示しています。

📚 ドキュメント

開発

このプロジェクトは、コードのlintingとフォーマットに ruff を、静的型チェックに mypy を、テストに pytest を使用しています。

Lintingとフォーマット

lintingの問題をチェックするには：

ruff check

コードをフォーマットするには：

ruff format

これらのコマンドは scripts/lint.sh スクリプトを介しても利用できます。

静的解析

静的解析（mypy, bandit, semgrep）を実行するには：

./scripts/static-analysis.sh

このスクリプトは .pre-commit-config.yaml でpre-commitフックとしても設定されています。

テストの実行

カバレッジ付きでテストを実行するには：

./scripts/test.sh

これによりpytestが実行され、カバレッジレポートが生成されます。結合レポートとクリーンアップには、次のコマンドを使用できます：

./scripts/test-cov.sh

Pre-commitフック

このプロジェクトは .pre-commit-config.yaml で定義されたpre-commitフックを使用しています。フックをインストールするには：

pre-commit install

フックは各コミットの前に自動的に実行されます。

ビルドと公開

このプロジェクトはHatchを使用してビルドと公開を行います。 プロジェクトをビルドするには：

hatch build

プロジェクトを公開するには：

hatch publish

これらのコマンドは scripts/publish.sh スクリプトを介しても利用できます。