Openapi MCP

🚀 OpenAPI智能代理工具使用說明

OpenAPI智能代理工具 openapi-mcp 是一個基於OpenAPI規範生成智能代理工具的腳手架。它能根據給定的OpenAPI/Swagger規範自動生成強大工具，可識別API端點和參數、支持請求重試、優化性能等，為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 具有以下強大特性：

• 自動發現能力：識別目標API的所有端點和參數
• 請求重試機制：支持失敗重試和熔斷策略
• 性能優化：內置結果緩存和鏈路監控
• 擴展插件系統：支持自定義中間件和後處理邏輯

📦 安裝指南

使用預構建鏡像

• Docker Hub 鏡像：ckan tong/openapi-mcp:latest
• 特性：
  • 已配置默認日誌記錄級別為 info
  • 已安裝 python3.8, pip, setuptools

本地構建鏡像

# 在項目根目錄下運行以下命令
docker build . --tag openapi-mcp:latest

💻 使用示例

必要參數

可選參數

📚 詳細文檔

核心功能模塊

代理服務器（MCP）

• 自動發現API端點
• 智能路由請求
• 請求增強與重試

日誌與跟蹤

• 分佈式鏈路追蹤：集成Jaeger或SkyWalking
• 即時日誌查詢：支持ELK Stack

高級功能

• 熔斷降級：保護API調用失敗情況
• 限流策略：防止系統過載
• 結果緩存：提升響應速度和可用性

示例項目結構

# 項目根目錄結構示例：
.
├── 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