跳到主要内容

参数

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

  • rules

    array[object]

    必填


    按顺序执行的访问控制规则数组。第一条 expr 条件全部满足(或未设置 expr)的规则生效,其余规则跳过。每条规则必须且只能配置 allow_toolsdeny_tools 其中之一。

    • allow_tools

      array[string]


      允许消费者调用和在 tools/list 中查看的 MCP 工具名称白名单。匹配方式为精确匹配,区分大小写。空数组([])将拒绝所有工具。

      每条规则中 allow_toolsdeny_tools 必须二选一,不能同时配置。

    • deny_tools

      array[string]


      禁止消费者调用的 MCP 工具名称黑名单。被拒绝的工具同样会从 tools/list 中隐藏。匹配方式为精确匹配,区分大小写。

      每条规则中 allow_toolsdeny_tools 必须二选一,不能同时配置。

    • rejected_code

      integer

      默认值:403

      有效值:

      200 到 599


      此规则拒绝 tools/call 请求时返回的 HTTP 状态码。

    • rejected_msg

      string

      默认值:MCP tool is not allowed

      有效值:

      非空字符串


      此规则拒绝 tools/call 请求时响应体中返回的错误消息。

    • expr

      array


      由一个或多个 APISIX 表达式组成的匹配条件数组。仅当所有表达式求值为 true 时,此规则才生效。如未设置,则此规则无条件匹配(兜底规则)。

  • max_resp_body_size

    integer

    默认值:67108864


    进行工具过滤时缓冲到内存中的响应体最大字节数。超过该上限的响应体会被截断。自 API7 企业版 3.9.x 系列的 3.9.17 版本起可用,3.10.x 系列自 3.10.4 版本起可用。