Openapi

🚀 OpenAPI to Model Context Protocol (MCP) Proxy

The OpenAPI-MCP Proxy transforms OpenAPI specifications into MCP tools, enabling AI agents to access external APIs without custom wrappers!

🚀 Quick Start

The OpenAPI to Model Context Protocol (MCP) proxy server bridges the gap between AI agents and external APIs by dynamically converting OpenAPI specifications into standardized MCP tools, resources, and prompts.

✨ Features

• Tool Registration: Convert OpenAPI definitions into MCP-compatible tools, supporting the handling of complex data structures.
• Automatic Resource Registration: Generate resource objects from OpenAPI component schemas and register them via well-defined URIs (e.g., /resource/{name}).
• Contextual Prompts: Generate prompts based on API operations to guide LLMs in using relevant endpoints, enhancing interactivity.

sequenceDiagram
    participant LLM as Claude/GPT
    participant MCP as OpenAPI-MCP Proxy
    participant API as External API

    Note over LLM, API: Communication Flow

    LLM->>MCP: 1. Initialize (initialize)
    MCP-->>LLM: Metadata, tools, resources, and prompts

    LLM->>MCP: 2. Request tool list (tools_list)
    MCP-->>LLM: Detailed list of tools, including resources and prompts

    LLM->>MCP: 3. Call tool (tools_call)

    alt With OAuth2
        MCP->>API: Request OAuth2 access token
        API-->>MCP: Receive access token
    end

    MCP->>API: 4. Execute API call, correctly formatted
    API-->>MCP: 5. API response (JSON format)

    alt Type conversion
        MCP->>MCP: 6. Convert parameters to correct data types
    end

    MCP-->>LLM: 7. Formatted API response

    alt Dry run mode
        LLM->>MCP: Call with dry_run=true
        MCP-->>LLM: Show request information without executing the call
    end

🤝 Contribution Guidelines

• Fork this repository.
• Create a new branch.
• Submit a pull request clearly describing the changes.

📄 License

MIT License

If this project helps you, please give it a star on GitHub!