OpenAPI to MCP | APISIX & API7 API Gateway Docs

Parameters

See plugin common configurations for configuration options available to all plugins.

transport
string
required
default: sse
vaild vaule:
sse or streamable_http
Transport method for client-server communication. The streamable_http method is recommended for production deployments, as it supports stateless communication suitable for multiple gateway instances. The sse method is stateful and may exhibit unexpected behavior when multiple gateways are deployed.
openapi_url
string
required
URL of the OpenAPI specification document that defines the API structure to be exposed through MCP.
Note that the plugin supports only OpenAPI Specification (OAS) version 3. OpenAPI v2 (Swagger) is not supported.
Additionally, the plugin has a known parsing issue when handling oneOf schemas in OpenAPI v3 document retrieved from openapi_url. In this case, the MCP client will be stuck at tool loading.
base_url
string
required
Base URL of the API service where requests will be forwarded. Support built-in variables in values (available from API7 Enterprise version 3.8.19), for example, https://${http_baseurl}.swagger.io.
headers
object
Headers to include in requests to the upstream service. Support built-in variables in values, for example, $arg_username-$http_apikey.