Openapi MCP

🚀 OpenAPI Intelligent Agent Tool Usage Guide

This OpenAPI intelligent agent tool is a powerful scaffolding that automatically generates a set of functional tools based on the given OpenAPI/Swagger specification. It offers features like automatic API discovery, request retry mechanisms, performance optimization, and an extensible plugin system.

🚀 Quick Start

Run the Image Directly

# Example: Use the Weatherbit API example
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

Start the Example Project with Docker Compose

# Run the following command in the example directory
docker-compose up --build

✨ Features

openapi-mcp is a scaffolding for generating intelligent agent tools based on the OpenAPI specification. It can automatically generate a set of powerful tools according to the given OpenAPI/Swagger specification, including:

• Automatic Discovery: Identify all endpoints and parameters of the target API.
• Request Retry Mechanism: Support retry on failure and circuit breaker strategies.
• Performance Optimization: Built - in result caching and link monitoring.
• Extensible Plugin System: Support custom middleware and post - processing logic.

🔧 Core Functional Modules

Proxy Server (MCP)

• Automatically discover API endpoints.
• Intelligent routing of requests.
• Request enhancement and retry.

Logging and Tracking

• Distributed Tracing: Integrate Jaeger or SkyWalking.
• Real - time Log Query: Support the ELK Stack.

Advanced Features

• Circuit Breaker and Degradation: Protect against API call failures.
• Rate Limiting Strategy: Prevent system overload.
• Result Caching: Improve response speed and availability.

📦 Installation

Use the Pre - built Image

• Docker Hub Image: ckan tong/openapi-mcp:latest
• Features:
  • The default logging level is configured as info.
  • python3.8, pip, and setuptools are installed.

Build the Image Locally

# Run the following command in the project root directory
docker build . --tag openapi-mcp:latest

💻 Usage Examples

Required Parameters

Optional Parameters

Example Project Structure

# Example of the project root directory structure:
.
├── requirements.txt       # Dependency management file
├── example/
│   └── weather/
│       ├── swagger.yaml  # OpenAPI specification file
│       └── README.md     # Example instruction document
└── main.py                # Main program entry file

📚 Documentation

Frequently Asked Questions

How to set the logging level?

• Modify the configuration file config/logging.yml or specify --log-level=debug in the command line.

How to make environment variables take effect?

• Pass environment variables to the Docker container through the -e parameter:

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

Advanced Configuration

Custom Plugin Development

# Example middleware plugin
class MyMiddleware:
    def __init__(self, app):
        self.app = app

    async def __call__(self, request):
        # Execute custom logic before the request
        print("Custom middleware executed")
        return await self.app(request)

Custom Result Processing

def custom_response_handler(response):
    # Add custom logic to the response processing
    pass

Related Documents

• OpenAPI Official Documentation
• Docker Best Practices

Contact Us

For feedback or technical support, please contact:

• Email: support@ckan - tong.com
• WeChat: CKAN - Tong