MCP Openapi Proxy

mcp - openapi - proxy is a Python package that implements a Model Context Protocol (MCP) server to dynamically expose REST APIs conforming to the OpenAPI specification as MCP tools, facilitating integration into MCP workflows.

Developer tools Cloud platform #API Proxy #Dynamic Tools #MCP Integration #OpenAPI .Python

rating : 2.5 points

downloads : 8.2K

update time : 2025-04-23

Open Site

What is the MCP Open API Proxy?

The MCP Open API Proxy is a server that dynamically converts REST APIs into MCP tools, enabling developers to easily integrate and use various APIs.

How to use the MCP Open API Proxy?

Simply configure the OpenAPI specification file URL to quickly enable the supported APIs.

Applicable Scenarios

Suitable for projects that need to quickly integrate multiple APIs, such as automation tools and data integration platforms.

Main Features

Dynamic Tool Generation

Automatically create MCP tools for each valid endpoint defined in the OpenAPI specification.

Simple Mode

Provide a predefined set of tools to simplify the configuration process.

Support for OpenAPI Specification

Compatible with OpenAPI v3, and may support v2 in the future.

Custom Authentication

Support authentication through JMESPath expressions.

Advantages

Quickly integrate multiple APIs

Dynamically generate tools without manual configuration

Support multiple authentication methods

Limitations

May require additional configuration for complex APIs

Depend on a valid OpenAPI specification file

How to Use

Installation

Install the MCP Open API Proxy through PyPI.

Configuration

Set necessary environment variables such as OPENAPI_SPEC_URL.

Start the Server

Run the server to expose the APIs.

Usage Examples

Glama Example

Quickly verify the Glama API.

Fly.io Example

Manage Fly.io machines.

Frequently Asked Questions

How to ensure the validity of the OpenAPI specification file?

What if the API requires custom authentication?

Related Resources

Official Documentation

The GitHub repository of the MCP Open API Proxy.

OpenAPI Specification

The official website of the OpenAPI specification.

Installation

Copy the following command to your Client for configuration

{
    "mcpServers": {
        "mcp-openapi-proxy": {
            "command": "uvx",
            "args": ["mcp-openapi-proxy"],
            "env": {
                "OPENAPI_SPEC_URL": "${OPENAPI_SPEC_URL}",
                "API_KEY": "${API_OPENAPI_KEY}"
            }
        }
    }
}

{
    "mcpServers": {
        "glama": {
            "command": "uvx",
            "args": ["mcp-openapi-proxy"],
            "env": {
                "OPENAPI_SPEC_URL": "https://glama.ai/api/mcp/openapi.json"
            }
        }
    }
}

{
    "mcpServers": {
        "flyio": {
            "command": "uvx",
            "args": ["mcp-openapi-proxy"],
            "env": {
                "OPENAPI_SPEC_URL": "https://raw.githubusercontent.com/abhiaagarwal/peristera/refs/heads/main/fly-machines-gen/fixed_spec.json",
                "API_KEY": "<your_flyio_token_here>"
            }
        }
    }
}

{
    "mcpServers": {
        "render": {
            "command": "uvx",
            "args": ["mcp-openapi-proxy"],
            "env": {
                "OPENAPI_SPEC_URL": "https://api-docs.render.com/openapi/6140fb3daeae351056086186",
                "TOOL_WHITELIST": "/services,/maintenance",
                "API_KEY": "your_render_token_here"
            }
        }
    }
}

{
    "mcpServers": {
        "slack": {
            "command": "uvx",
            "args": ["mcp-openapi-proxy"],
            "env": {
                "OPENAPI_SPEC_URL": "https://raw.githubusercontent.com/slackapi/slack-api-specs/master/web-api/slack_web_openapi_v2.json",
                "TOOL_WHITELIST": "/chat,/bots,/conversations,/reminders,/files,/users",
                "API_KEY": "<your_slack_bot_token, starts with xoxb>",
                "STRIP_PARAM": "token",
                "TOOL_NAME_PREFIX": "slack_"
            }
        }
    }
}

{
    "mcpServers": {
        "getzep": {
            "command": "uvx",
            "args": ["mcp-openapi-proxy"],
            "env": {
                "OPENAPI_SPEC_URL": "https://raw.githubusercontent.com/matthewhand/mcp-openapi-proxy/refs/heads/main/examples/getzep.swagger.json",
                "TOOL_WHITELIST": "/sessions",
                "API_KEY": "<your_getzep_api_key>",
                "API_AUTH_TYPE": "Api-Key",
                "TOOL_NAME_PREFIX": "zep_"
            }
        }
    }
}

{
    "mcpServers": {
        "virustotal": {
            "command": "uvx",
            "args": ["mcp-openapi-proxy"],
            "env": {
                "OPENAPI_SPEC_URL": "https://raw.githubusercontent.com/matthewhand/mcp-openapi-proxy/refs/heads/main/examples/virustotal.openapi.yml",
                "EXTRA_HEADERS": "x-apikey: ${VIRUSTOTAL_API_KEY}",
                "OPENAPI_SPEC_FORMAT": "yaml"
            }
        }
    }
}

{
  "mcpServers": {
    "notion": {
      "command": "uvx",
      "args": [
        "mcp-openapi-proxy"
      ],
      "env": {
          "API_KEY": "ntn_<your_key>",
          "OPENAPI_SPEC_URL": "https://storage.googleapis.com/versori-assets/public-specs/20240214/NotionAPI.yml",
          "SERVER_URL_OVERRIDE": "https://api.notion.com",
          "EXTRA_HEADERS": "Notion-Version: 2022-06-28"
      }
    }
  }
}

{
  "mcpServers": {
    "asana": {
      "command": "uvx",
      "args": [
        "mcp-openapi-proxy"
      ],
      "env": {
        "OPENAPI_SPEC_URL": "https://raw.githubusercontent.com/Asana/openapi/refs/heads/master/defs/asana_oas.yaml",
        "SERVER_URL_OVERRIDE": "https://app.asana.com/api/1.0",
        "TOOL_WHITELIST": "/workspaces,/tasks,/projects,/users",
        "API_KEY": "${ASANA_API_KEY}"
      }
    }
  }
}

{
    "mcpServers": {
        "apisguru": {
            "command": "uvx",
            "args": ["mcp-openapi-proxy"],
            "env": {
                "OPENAPI_SPEC_URL": "https://raw.githubusercontent.com/APIs-guru/openapi-directory/refs/heads/main/APIs/apis.guru/2.2.0/openapi.yaml"
            }
        }
    }
}

{
    "mcpServers": {
        "netbox": {
            "command": "uvx",
            "args": ["mcp-openapi-proxy"],
            "env": {
                "OPENAPI_SPEC_URL": "https://raw.githubusercontent.com/APIs-guru/openapi-directory/refs/heads/main/APIs/netbox.dev/3.4/openapi.yaml",
                "API_KEY": "${NETBOX_API_KEY}"
            }
        }
    }
}

{
  "mcpServers": {
    "wolframalpha": {
      "command": "uvx",
      "args": [
        "mcp-openapi-proxy"
      ],
      "env": {
        "OPENAPI_SPEC_URL": "https://raw.githubusercontent.com/APIs-guru/openapi-directory/refs/heads/main/APIs/wolframalpha.com/v0.1/openapi.yaml",
        "API_KEY": "${WOLFRAM_LLM_APP_ID}"
      }
    }
  }
}

Note: Your key is sensitive information, do not share it with anyone.

🚀 MCP Server Configuration Guide

This guide provides a step - by - step process for configuring and running the MCP server, including installation, configuration, usage examples, troubleshooting, and license information.

🚀 Quick Start

To get started with the MCP server, you need to install the necessary dependencies and follow the configuration steps.

📦 Installation

To run the MCP server, you need to install the following dependencies first:

Node.js (Recommended version: 16.x or higher)
npm (Recommended version: 7.x or higher)

The installation command is as follows:

npm install -g mcp-server

📚 Documentation

Example Configuration File

Here is a typical example of an MCP server configuration file:

{
  "mcpServers": {
    "development": {
      "command": "uvx",
      "args": ["mcp-server"],
      "env": {
        "NODE_ENV": "development",
        "PORT": 3000,
        "API_KEY": "your_api_key_here"
      }
    },
    "production": {
      "command": "uvx",
      "args": ["mcp-server"],
      "env": {
        "NODE_ENV": "production",
        "PORT": 3001,
        "API_KEY": "your_production_api_key"
      }
    }
  }
}

Environment Variable Configuration

The following are the key environment variables supported by the MCP server:

OPENAPI_SPEC_URL: Specify the URL or local file path of the OpenAPI specification.
TOOL_WHITELIST: Specify the allowed tool endpoints as a comma - separated string.
API_KEY: Specify the API access key.
DEBUG: Enable debug mode (when the value is true).

Example Usage

OPENAPI_SPEC_URL="https://example.com/openapi.yaml" TOOL_WHITELIST="/users,/posts" uvx mcp-server

💻 Usage Examples

MCP Server

Here is a typical configuration file for the MCP server:

{
  "mcpServers": {
    "default": {
      "command": "uvx",
      "args": ["mcp-server"],
      "env": {
        "OPENAPI_SPEC_URL": "https://example.com/openapi.json",
        "TOOL_WHITELIST": "/users,/posts",
        "API_KEY": "your_api_key"
      }
    }
  }
}

Box API Configuration Example

Here is an example of Box API configuration:

{
  "mcpServers": {
    "box": {
      "command": "uvx",
      "args": ["mcp-server"],
      "env": {
        "OPENAPI_SPEC_URL": "https://raw.githubusercontent.com/APIs-guru/openapi-directory/refs/heads/main/APIs/box.com/2.0.0/openapi.yaml",
        "TOOL_WHITELIST": "/files,/folders",
        "BOX_API_KEY": "your_box_api_key"
      }
    }
  }
}

Wolfram Alpha API Configuration Example

Here is an example of Wolfram Alpha API configuration:

{
  "mcpServers": {
    "wolfram-alpha": {
      "command": "uvx",
      "args": ["mcp-server"],
      "env": {
        "OPENAPI_SPEC_URL": "https://example.com/wolfram-alpha/openapi.json",
        "WOLFRAM_API_KEY": "your_wolfram_api_key"
      }
    }
  }
}

🔧 Troubleshooting

Common Issues

Problem: OpenAPI specification file not found
- Solution: Check if OPENAPI_SPEC_URL is correct and ensure that the path is accessible.
Problem: Tool endpoints are rejected
- Solution: Check if TOOL_WHITELIST contains the required endpoints, or set it to null to allow all endpoints.
Problem: API request fails
- Solution: Verify if API_KEY is valid and ensure that the API service is running properly.

Logging

The MCP server supports the following logging levels:

debug
info
warning
error

📄 License

This project is licensed under the MIT License. The specific terms are as follows:

MIT License

Copyright (c) [year] [author]

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

The above is the complete configuration guide for the MCP server. For further assistance, please refer to the official documentation or contact the support team.