跳到主要内容

参数​

请参阅 插件通用配置 了解所有插件可用的配置选项。

  • transport

    string

    required

    default: sse

    vaild vaule:

    sse or streamable_http

    客户端-服务器通信的传输方法。推荐在生产部署中使用 streamable_http 方法，因为它支持适合多个网关实例的无状态通信。sse 方法是有状态的，当部署多个网关时可能会表现出意外行为。

  • openapi_url

    string

    required

    定义要通过 MCP 暴露的 API 结构的 OpenAPI 规范文档的 URL。

    请注意，该插件仅支持 OpenAPI Specification (OAS) 3 版本。不支持 OpenAPI v2 (Swagger)。

    此外，该插件在处理从 openapi_url 获取的 OpenAPI v3 文档中的 oneOf 架构时存在已知的解析问题。在这种情况下，MCP 客户端将在加载工具时卡住。

  • base_url

    string

    required

    请求转发到的 API 服务的基础 URL。支持在值中使用内置变量（从 API7 企业版 3.8.19 版本开始可用），例如 https://${http_baseurl}.swagger.io。

  • headers

    object

    包含在发往上游服务的请求中的请求头。支持在值中使用内置变量，例如 $arg_username-$http_apikey。

  • flatten_parameters

    boolean

    default: false

    是否在工具架构中扁平化查询和路径参数。

    如果设置为 false，查询参数嵌套在 queryParameters 下，路径参数嵌套在 pathParameters 下。如果设置为 true，所有查询和路径参数直接放置在工具架构的 properties 下。

    将参数设置为 true 可以通过降低架构复杂性来简化 AI 模型交互。当查询和路径参数共享相同名称时，请保持参数为 false 以避免冲突。