Openapi MCP

🚀 OpenAPI 智能代理ツール使用説明

このOpenAPI 智能代理ツールは、OpenAPI仕様に基づいて強力な代理ツールを生成するためのものです。自動的にAPIのエンドポイントやパラメータを識別し、リクエストのリトライやパフォーマンス最適化などの機能を提供します。

🚀 クイックスタート

イメージを直接実行する

# 例：Weatherbit APIの例を使用する
docker run --rm -it \
  --mount type=bind,source="$(pwd)/example/weather",target=/app/example/weather \
  ckan tong/openapi-mcp:latest \
    --spec /app/example/weather/swagger.yaml \
    --api-key-env API_KEY \
    --api-key-name key \
    --api-key-loc query

Docker Composeを使用してサンプルプロジェクトを起動する

# exampleディレクトリで以下のコマンドを実行する
docker-compose up --build

✨ 主な機能

openapi-mcp はOpenAPI仕様に基づいて智能代理ツールを生成するスケルトンです。与えられたOpenAPI/Swagger仕様に基づいて、以下のような強力なツールを自動生成します。

• 自動発見機能：対象APIのすべてのエンドポイントとパラメータを識別する
• リクエストリトライメカニズム：失敗したリクエストのリトライとブレーカーポリシーをサポートする
• パフォーマンス最適化：結果のキャッシュとリンクモニタリングを内蔵する
• 拡張プラグインシステム：カスタムミドルウェアと事後処理ロジックをサポートする

代理サーバー（MCP）

• APIエンドポイントの自動発見
• リクエストのスマートルーティング
• リクエストの強化とリトライ

ログとトレース

• 分散型リンクトレーシング：JaegerまたはSkyWalkingを統合する
• リアルタイムログクエリ：ELK Stackをサポートする

高度な機能

• ブレーカーデグレード：API呼び出しの失敗を防ぐ
• レート制限ポリシー：システムの過負荷を防止する
• 結果キャッシュ：応答速度と可用性を向上させる

📦 インストール

事前構築済みイメージを使用する

• Docker Hubイメージ：ckan tong/openapi-mcp:latest
• 特徴：
  • デフォルトのログレベルが info に設定されている
  • python3.8, pip, setuptools がインストールされている

ローカルでイメージを構築する

# プロジェクトのルートディレクトリで以下のコマンドを実行する
docker build . --tag openapi-mcp:latest

📚 ドキュメント

必要なパラメータ

オプションパラメータ

サンプルプロジェクトの構造

# プロジェクトのルートディレクトリ構造の例：
.
├── requirements.txt       # 依存関係管理ファイル
├── example/
│   └── weather/
│       ├── swagger.yaml  # OpenAPI仕様ファイル
│       └── README.md     # サンプル説明ドキュメント
└── main.py                # メインプログラムのエントリポイント

よくある質問

ログレベルをどのように設定するか？

• 設定ファイル config/logging.yml を変更するか、コマンドラインで --log-level=debug を指定する

環境変数をどのように有効にするか？

• 環境変数を -e パラメータでDockerコンテナに渡す：

docker run --rm -it -e API_KEY=your_key ...

高度な設定

カスタムプラグインの開発

# サンプルミドルウェアプラグイン
class MyMiddleware:
    def __init__(self, app):
        self.app = app

    async def __call__(self, request):
        # リクエスト前にカスタムロジックを実行する
        print("Custom middleware executed")
        return await self.app(request)

カスタム結果処理

def custom_response_handler(response):
    # レスポンス処理にカスタムロジックを追加する
    pass

関連ドキュメント

• OpenAPI公式ドキュメント
• Dockerベストプラクティス

お問い合わせ

フィードバックや技術サポートが必要な場合は、以下の方法でお問い合わせください。

• メール：support@ckan-tong.com
• 微信：CKAN-Tong