MCP Server 插件配置
发布时间 2025-04-03
功能说明
mcp-server插件提供了基于 Model Context Protocol (MCP) 的 AI 工具集成能力。MCP 是一种专为 AI 助手设计的协议,它定义了 AI 模型与外部工具和资源交互的标准方式。通过此插件,您可以:
- 无需编写代码,将现有的 REST API 转换为 AI 助手可调用的工具
- 利用 Higress 网关提供的统一认证、鉴权、限流和可观测性能力
- 快速构建和部署 AI 工具和服务

通过 Higress 托管 MCP Server,可以实现:
- 统一的认证和鉴权机制,确保 AI 工具调用的安全性
- 精细化的速率限制,防止滥用和资源耗尽
- 完整的审计日志,记录所有工具调用行为
- 丰富的可观测性,监控工具调用的性能和健康状况
- 简化的部署和管理,通过 Higress 插件机制快速添加新的 MCP Server
运行属性
插件执行阶段:默认阶段
插件执行优先级:30
配置字段
服务器配置
| 名称 | 数据类型 | 填写要求 | 默认值 | 描述 |
|---|---|---|---|---|
server.name | string | 必填 | - | MCP 服务器的名称。如果使用插件内置的 MCP 服务器(如 quark-search),只需配置此字段为对应的名称,无需配置 tools 字段。如果是 REST-to-MCP 场景,此字段可以填写任意值。 |
server.type | string | 选填 | rest | MCP 服务器类型。可选值:rest(REST-to-MCP 转换)、mcp-proxy(MCP 代理)。如果不指定,默认为 rest 类型。 |
server.config | object | 选填 | {} | 服务器配置,如 API 密钥等 |
server.mcpServerURL | string | 当 server.type 为 mcp-proxy 时必填 | - | 后端 MCP 服务器的 URL 地址。仅在 mcp-proxy 类型时使用。支持完整 URL(如 http://example.com/mcp)或路径(如 /mcp,将使用路由集群的基础 URL)。 |
server.timeout | integer | 选填 | 5000 | 请求后端服务的超时时间(毫秒)。适用于 mcp-proxy 类型。 |
server.transport | string | 当 server.type 为 mcp-proxy 时必填 | - | 传输协议类型。可选值:http(StreamableHTTP)、sse(Server-Sent Events)。 |
server.passthroughAuthHeader | boolean | 选填 | false | 是否透传 Authorization 请求头。当设置为 true 时,即使没有配置客户端到网关的安全认证(defaultDownstreamSecurity 或工具级 security),也会将客户端的 Authorization 请求头透传到后端。默认为 false,即在没有明确配置安全认证时会移除 Authorization 请求头,防止客户端凭证被错误地传递到后端。此字段适用于需要直接透传原始认证信息的场景。 |
server.securitySchemes | array of object | 选填 | - | 定义可重用的认证方案,供工具引用。详见”认证与安全”章节。 |
server.defaultDownstreamSecurity | object | 选填 | - | 服务器级别的默认客户端到网关认证配置,用于所有 tools/list 和 tools/call 请求。可被工具级别的 security 配置覆盖。支持 id(引用 securitySchemes)和 passthrough(透传标志)字段。 |
server.defaultUpstreamSecurity | object | 选填 | - | 服务器级别的默认网关到后端认证配置,用于所有后端请求。可被工具级别的 requestTemplate.security 配置覆盖。支持 id(引用 securitySchemes)和 credential(覆盖默认凭证)字段。 |
允许的工具配置
| 名称 | 数据类型 | 填写要求 | 默认值 | 描述 |
|---|---|---|---|---|
allowTools | array of string | 选填 | - | 允许调用的工具列表。如不指定,则允许所有工具 |
动态工具权限控制
除了在配置中静态定义 allowTools 外,还支持通过 HTTP 请求头 x-envoy-allow-mcp-tools 动态控制工具访问权限。这使得前置插件(如认证、鉴权插件)可以根据用户身份或其他条件动态设置允许的工具列表。
Header 格式:
x-envoy-allow-mcp-tools: tool1,tool2,tool3权限控制逻辑:
- 配置级别
allowTools(静态):在插件配置中定义的基础工具白名单 - Header 级别
x-envoy-allow-mcp-tools(动态):从请求头中读取的工具白名单 - 最终生效权限:配置和 Header 中指定的工具列表的交集
Header 值的语义:
| Header 状态 | 行为 |
|---|---|
| Header 不存在 | 没有额外限制,使用配置中的 allowTools |
Header 为空字符串 "" | 没有额外限制,使用配置中的 allowTools |
Header 为空白字符串 " , , " | 禁止访问所有工具(空集合) |
Header 有值 "tool1,tool2" | 与配置的 allowTools 取交集 |
使用场景示例:
-
基于用户角色的权限控制
# 配置中定义所有可用工具allowTools:- get-user-info- update-user-info- delete-user-info- admin-operation前置认证插件可以根据用户角色设置不同的工具权限:
- 普通用户:
x-envoy-allow-mcp-tools: get-user-info - 高级用户:
x-envoy-allow-mcp-tools: get-user-info,update-user-info - 管理员:不设置 header(允许所有配置中的工具)
- 普通用户:
-
多租户场景
# 配置中定义租户可用的工具allowTools:- tenant-query-data- tenant-update-data- tenant-report前置插件根据租户订阅套餐动态控制:
- 基础版:
x-envoy-allow-mcp-tools: tenant-query-data - 专业版:
x-envoy-allow-mcp-tools: tenant-query-data,tenant-update-data - 企业版:
x-envoy-allow-mcp-tools: tenant-query-data,tenant-update-data,tenant-report
- 基础版:
-
临时权限限制
在特殊情况下(如系统维护),前置插件可以临时限制某些工具的访问:
x-envoy-allow-mcp-tools: read-only-tool1,read-only-tool2
前置插件集成指南:
对于需要动态设置工具权限的前置插件(如认证、鉴权插件),必须使用 proxywasm.ReplaceHttpRequestHeader 来设置 x-envoy-allow-mcp-tools header:
// 正确的方式:使用 ReplaceHttpRequestHeader// 这会覆盖用户可能传入的任何值,确保安全性proxywasm.ReplaceHttpRequestHeader("x-envoy-allow-mcp-tools", "tool1,tool2,tool3")
// ❌ 错误的方式:使用 AddHttpRequestHeader// 这可能导致用户传入的值被保留,造成安全隐患proxywasm.AddHttpRequestHeader("x-envoy-allow-mcp-tools", "tool1,tool2,tool3")使用 ReplaceHttpRequestHeader 可以确保:
- 安全性:用户无法通过直接在请求中传入
x-envoy-allow-mcp-toolsheader 来绕过权限控制 - 可靠性:前置插件设置的权限配置始终生效,不会被用户输入覆盖
- 可预测性:MCP Server 插件接收到的始终是前置插件设置的权限值
注意事项:
- Header 值使用逗号分隔多个工具名称
- 工具名称前后的空白字符会被自动去除
- 当配置的
allowTools为空数组时,无论 header 如何设置,都会禁止所有工具访问 - MCP Server 插件会自动移除
x-envoy-allow-mcp-toolsheader,不会传递给后端服务
REST-to-MCP 工具配置
| 名称 | 数据类型 | 填写要求 | 默认值 | 描述 |
|---|---|---|---|---|
tools | array of object | 选填 | [] | REST-to-MCP 工具配置列表 |
tools[].name | string | 必填 | - | 工具名称 |
tools[].description | string | 必填 | - | 工具功能描述 |
tools[].args | array of object | 必填 | [] | 工具参数定义 |
tools[].args[].name | string | 必填 | - | 参数名称 |
tools[].args[].description | string | 必填 | - | 参数描述 |
tools[].args[].type | string | 选填 | string | 参数类型(string, number, integer, boolean, array, object) |
tools[].args[].required | boolean | 选填 | false | 参数是否必需 |
tools[].args[].default | any | 选填 | - | 参数默认值 |
tools[].args[].enum | array | 选填 | - | 参数允许的值列表 |
tools[].args[].items | object | 选填 | - | 数组项的模式(当type为array时) |
tools[].args[].properties | object | 选填 | - | 对象属性的模式(当type为object时) |
tools[].args[].position | string | 选填 | - | 参数在请求中的位置(query, path, header, cookie, body) |
tools[].requestTemplate | object | 必填 | - | HTTP 请求模板 |
tools[].requestTemplate.url | string | 必填 | - | 请求 URL 模板 |
tools[].requestTemplate.method | string | 必填 | - | HTTP 方法(GET/POST等) |
tools[].requestTemplate.headers | array of object | 选填 | [] | 请求头模板 |
tools[].requestTemplate.headers[].key | string | 必填 | - | 请求头名称 |
tools[].requestTemplate.headers[].value | string | 必填 | - | 请求头值模板 |
tools[].requestTemplate.body | string | 选填 | - | 请求体模板(与argsToJsonBody、argsToUrlParam、argsToFormBody互斥) |
tools[].requestTemplate.argsToJsonBody | boolean | 选填 | false | 当为true时,参数将直接用作JSON请求体(与body、argsToUrlParam、argsToFormBody互斥) |
tools[].requestTemplate.argsToUrlParam | boolean | 选填 | false | 当为true时,参数将作为查询参数添加到URL中(与body、argsToJsonBody、argsToFormBody互斥) |
tools[].requestTemplate.argsToFormBody | boolean | 选填 | false | 当为true时,参数将以application/x-www-form-urlencoded格式编码在请求体中(与body、argsToJsonBody、argsToUrlParam互斥) |
tools[].responseTemplate | object | 必填 | - | HTTP 响应转换模板 |
tools[].responseTemplate.body | string | 选填 | - | 响应体转换模板(与prependBody和appendBody互斥) |
tools[].responseTemplate.prependBody | string | 选填 | - | 在响应体前插入的文本(与body互斥) |
tools[].responseTemplate.appendBody | string | 选填 | - | 在响应体后插入的文本(与body互斥) |
tools[].security | object | 选填 | - | 工具级别安全配置,用于定义 MCP Client 和 MCP Server 之间的认证方式,并支持凭证透传。 |
tools[].security.id | string | 当 tools[].security 配置时必填 | - | 引用在 server.securitySchemes 中定义的认证方案 ID。 |
tools[].security.passthrough | boolean | 选填 | false | 是否启用透明认证。如果为 true,则从 MCP Client 请求中提取的凭证将用于 requestTemplate.security 定义的认证方案。 |
tools[].requestTemplate.security | object | 选填 | - | HTTP 请求模板的安全配置,用于定义 MCP Server 和 REST API 之间的认证方式。 |
tools[].requestTemplate.security.id | string | 当 tools[].requestTemplate.security 配置时必填 | - | 引用在 server.securitySchemes 中定义的认证方案 ID。 |
tools[].requestTemplate.security.credential | string | 选填 | - | 覆盖 server.securitySchemes 中定义的默认凭证。如果同时启用了 tools[].security.passthrough,则此字段将被忽略,优先使用透传的凭证。 |
tools[].errorResponseTemplate | string | 选填 | - | HTTP响应Status>=300 \ |
MCP 传输协议
MCP 代理服务器 (mcp-proxy 类型) 支持两种传输协议与后端 MCP 服务器通信:
StreamableHTTP 协议 (transport: http)
StreamableHTTP 是 MCP 的默认 HTTP 传输协议,使用标准的 HTTP 请求/响应模型:
-
特点:
- 简单的请求-响应模型
- 使用标准 HTTP POST 请求
- 响应为完整的 JSON 数据
- 适合大多数 MCP 服务器实现
-
配置示例:
server: name: my-mcp-proxy type: mcp-proxy transport: http mcpServerURL: "http://backend-mcp.example.com/mcp"SSE 协议 (transport: sse)
SSE (Server-Sent Events) 是 MCP 的流式传输协议,支持实时数据推送:
-
特点:
- 基于 HTTP 的单向流式通信
- 支持长连接和实时消息推送
- 适合需要实时更新的场景
- 协议流程:
- 发现阶段:向后端发送 POST 请求获取 SSE 端点 URL
- 初始化阶段:通过 SSE 端点发送
initialize消息 - 通知阶段:发送
notifications/initialized通知 - 工具调用:根据需要执行
tools/list或tools/call请求
-
URL 配置:
- 支持完整 URL:
http://example.com/sse - 支持路径:
/sse(将使用mcpServerURL的基础 URL)
- 支持完整 URL:
-
配置示例:
server: name: my-sse-proxy type: mcp-proxy transport: sse mcpServerURL: "http://backend-mcp.example.com" timeout: 10000 # SSE 可能需要更长的超时时间认证与安全
MCP Server 插件支持灵活的认证配置,以确保与后端 REST API 或 MCP 服务器通信的安全性。插件支持两种服务器类型的认证配置:
- REST-to-MCP 服务器 (
rest类型):将客户端请求转换为 REST API 调用 - MCP 代理服务器 (
mcp-proxy类型):将客户端请求代理到后端 MCP 服务器
无论哪种类型,都支持两层认证机制:
- 客户端到网关认证:验证调用 MCP Server 的客户端身份
- 网关到后端认证:MCP Server 调用后端服务时的认证方式
定义认证方案 (server.securitySchemes)
您可以在服务器级别定义一组可重用的认证方案。这些方案之后可以被各个工具引用,用于配置 MCP Server 向后端 REST API 发起请求时的认证方式。
配置字段 (server.securitySchemes[]):
| 名称 | 数据类型 | 填写要求 | 描述 |
|---|---|---|---|
id | string | 必填 | 认证方案的唯一标识符,供工具配置引用。 |
type | string | 必填 | 认证类型,支持 http (用于 Basic 和 Bearer认证) 和 apiKey。 |
scheme | string | 选填 | 当 type 为 http 时指定具体的方案,如 basic 或 bearer。 |
in | string | 选填 | 当 type 为 apiKey 时指定 API 密钥的位置,如 header 或 query。 |
name | string | 选填 | 当 type 为 apiKey 时指定 Header 名称或查询参数名称。 |
defaultCredential | string | 选填 | 此方案的默认凭证。例如,对于 Basic Auth,可以是 “user:password ”;对于 Bearer Token,是 Token 本身;对于 API Key,是 Key 本身。 |
示例 (server.securitySchemes):
server: name: my-api-server securitySchemes: - id: MyBasicAuth type: http scheme: basic defaultCredential: "admin:secretpassword" # 默认的用户名和密码 - id: MyBearerToken type: http scheme: bearer defaultCredential: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." # 默认的Bearer Token - id: MyApiKeyInHeader type: apiKey in: header name: X-Custom-API-Key # API Key 在名为 X-Custom-API-Key 的 Header 中 defaultCredential: "abcdef123456" # 默认的 API Key - id: MyApiKeyInQuery type: apiKey in: query name: "api_token" # API Key 在名为 api_token 的查询参数中 defaultCredential: "uvwxyz789012"在工具中应用认证方案
定义了 server.securitySchemes 后,您可以在每个工具的 requestTemplate.security 中通过 id 引用这些方案,以指定 MCP Server 调用后端 REST API 时使用的认证方式。
tools[].requestTemplate.security.id: 引用server.securitySchemes中定义的认证方案的id。tools[].requestTemplate.security.credential: 可选。如果提供,它将覆盖所引用方案中的defaultCredential。这允许您为特定工具使用不同的凭证,即使它们共享相同的认证机制。
示例:
tools:- name: get-user-details # ... 其他工具配置 ... requestTemplate: url: "https://api.example.com/users/{{.args.userId}}" method: GET security: id: MyBearerToken # 使用上面定义的 MyBearerToken 方案 # credential: "override_token_for_this_tool" # 可选:为此工具覆盖默认Token# ...- name: update-inventory # ... 其他工具配置 ... requestTemplate: url: "https://api.example.com/inventory/{{.args.itemId}}" method: POST security: id: MyApiKeyInHeader # 使用 MyApiKeyInHeader 方案 # 此工具将使用 MyApiKeyInHeader 中定义的 defaultCredential透明认证 (Passthrough Authentication)
透明认证功能允许将 MCP Client (例如 AI 助手) 调用 MCP Server 时提供的凭证,透传给 MCP Server 调用后端 REST API 时的认证过程。
配置方式:
-
确保相关认证方案已在
server.securitySchemes中定义。这包括客户端用于连接到 MCP Server 的方案,以及 MCP Server 用于连接到后端 REST API 的方案。 -
配置工具级别认证 (
tools[].security): 在需要透传凭证的工具中,配置security字段:id: 引用server.securitySchemes中定义的、用于 MCP Client 与 MCP Server 之间的认证方案。插件将根据此方案从客户端请求中提取凭证,并清理原始请求中的该凭证。passthrough: true: 启用透明认证。
-
配置请求模板认证 (
tools[].requestTemplate.security): 在工具的requestTemplate中,配置security字段:id: 引用server.securitySchemes中定义的、用于 MCP Server 与后端 REST API 之间的认证方案。- 当
tools[].security.passthrough为true时,从客户端提取的凭证将根据此requestTemplate.security方案应用于对后端 REST API 的调用。
示例:
假设 MCP Client 使用 Bearer Token 调用 MCP Server,而 MCP Server 需要使用 API Key 调用后端的 REST API。
server: name: product-api-server securitySchemes: - id: ClientSideBearer # 客户端使用Bearer Token type: http scheme: bearer - id: BackendApiKey # 后端API使用X-API-Key type: apiKey in: header name: X-API-Key # defaultCredential: "optional_default_backend_key"
tools:- name: get-product-securely description: "获取产品信息(安全透传)" security: # 客户端 -> MCP Server 认证配置 id: ClientSideBearer # MCP Server期望客户端使用此方案,并会尝试提取此类型的凭证 passthrough: true # 启用透传 args: - name: product_id description: "产品ID" type: string required: true requestTemplate: security: # MCP Server -> 后端 REST API 认证配置 id: BackendApiKey # 后端API需要此方案。透传的凭证将按此方案应用。 url: "https://api.example.com/products/{{.args.product_id}}" method: GET工作流程:
- MCP Client 发起请求到 MCP Server 的
get-product-securely工具,并在Authorization头中携带Bearer <client_token>。 - MCP Server 根据
tools[].security(id:ClientSideBearer) 识别出客户端使用的是 Bearer Token。它会从请求中提取<client_token>并移除原始的Authorization头。 - 因为
passthrough: true,提取出的<client_token>被标记为透传凭证。 - MCP Server 准备调用后端 REST API。它查看
requestTemplate.security(id:BackendApiKey)。 - 由于启用了透传,MCP Server 将之前提取的
<client_token>作为凭证值,按照BackendApiKey方案(即作为名为X-API-Key的 HTTP Header)添加到对https://api.example.com/products/...的请求中。 - 后端 REST API 收到请求,其中
X-API-KeyHeader 的值为<client_token>。
注意事项:
- 当
tools[].security.passthrough为true时,requestTemplate.security.credential字段会被忽略,优先使用透传的凭证。 - 透传的凭证值会直接用于
requestTemplate.security指定的认证方案。请确保凭证的格式与目标认证方案兼容。extractAndRemoveIncomingCredential函数会尝试提取核心凭证部分(例如,Bearer token 值,Basic auth 的 base64 编码部分)。
服务器级别默认认证配置
为了简化配置和确保一致性,MCP Server 插件支持在服务器级别设置默认的认证配置。这些默认配置将应用于所有工具和非工具特定的接口(如 tools/list)。
server.defaultDownstreamSecurity
定义客户端到网关的默认认证配置。这个配置将应用于:
- 所有没有明确配置
security字段的工具 tools/list请求(获取工具列表)- 其他非工具特定的 MCP 协议接口
配置字段:
id:引用server.securitySchemes中定义的认证方案 IDpassthrough:是否启用透明认证(可选,默认为 false)
server.defaultUpstreamSecurity
定义网关到后端的默认认证配置。这个配置将应用于:
- 所有没有明确配置
requestTemplate.security字段的工具 tools/list等需要访问后端服务的请求
配置字段:
id:引用server.securitySchemes中定义的认证方案 IDcredential:覆盖默认凭证(可选)
优先级规则
认证配置的优先级从高到低:
- 工具级别配置(
tools[].security和tools[].requestTemplate.security) - 服务器级别默认配置(
server.defaultDownstreamSecurity和server.defaultUpstreamSecurity) - 认证方案中的默认凭证(
server.securitySchemes[].defaultCredential)
使用场景
服务器级别默认认证特别适用于以下场景:
- 统一认证策略:所有工具都使用相同的认证方式
- MCP 代理服务器:需要为
tools/list等非工具特定请求提供认证 - 简化配置:减少每个工具重复配置相同的认证信息
参数类型支持
REST-to-MCP 工具支持多种参数类型,使您可以更精确地定义工具参数:
- string: 字符串类型(默认)
- number: 数字类型(浮点数)
- integer: 整数类型
- boolean: 布尔类型(true/false)
- array: 数组类型,使用
items字段定义数组元素的模式 - object: 对象类型,使用
properties字段定义对象属性的模式
示例:
args:- name: query description: "搜索关键词" type: string required: true- name: limit description: "返回结果数量" type: integer default: 10- name: filters description: "过滤条件" type: object properties: category: type: string enum: ["food", "hotel", "attraction"] price: type: integer minimum: 0- name: coordinates description: "坐标点列表" type: array items: type: object properties: lat: type: number lng: type: number参数位置控制
REST-to-MCP 工具支持通过 position 字段精确控制每个参数在请求中的位置。这使您可以更灵活地构建 API 请求,例如同时使用路径参数、查询参数和请求体参数。
支持的位置类型
- query: 参数将作为查询参数添加到 URL 中
- path: 参数将替换 URL 中的路径占位符,例如
/pet/{petId}中的{petId} - header: 参数将作为 HTTP 头添加到请求中
- cookie: 参数将作为 Cookie 添加到请求中
- body: 参数将添加到请求体中(根据内容类型自动格式化为 JSON 或表单)
使用示例
args:- name: petId description: "宠物ID" type: string required: true position: path- name: token description: "认证令牌" type: string required: true position: header- name: sessionId description: "会话ID" type: string position: cookie- name: limit description: "返回结果数量" type: integer default: 10 position: query- name: tags description: "标签列表" type: array position: body在上面的示例中:
petId将替换 URL 中的{petId}占位符token将作为 HTTP 头添加到请求中sessionId将作为 Cookie 添加到请求中limit将作为查询参数添加到 URL 中tags将添加到请求体中
与批量参数处理选项的关系
当使用 position 指定参数位置时,这些参数将按照指定的位置处理,而不会受到批量参数处理选项(argsToJsonBody、argsToUrlParam、argsToFormBody)的影响。只有未指定 position 的参数才会受到这些批量选项的影响。
例如,如果您同时使用了 position 和 argsToJsonBody:
- 指定了
position: query的参数会添加到 URL 查询字符串中 - 指定了
position: header的参数会添加到 HTTP 头中 - 指定了
position: path的参数会替换 URL 中的占位符 - 指定了
position: cookie的参数会添加到 Cookie 中 - 指定了
position: body的参数会添加到 JSON 请求体中 - 未指定
position的参数会通过argsToJsonBody添加到 JSON 请求体中
此外,如果在 requestTemplate 中明确指定了 body,则所有 position: body 的参数都将被忽略,以避免冲突。
请求参数传递方式
除了使用 position 精确控制每个参数的位置外,REST-to-MCP 工具还支持四种批量参数处理方式,这些选项是互斥的,只能选择其中一种:
-
body: 使用模板手动构建请求体。这是最灵活的方式,允许您完全控制请求体的格式。
requestTemplate:body: |{"query": "{{.args.query}}","filters": {{toJson .args.filters}},"options": {"limit": {{.args.limit}}}} -
argsToJsonBody: 当设置为
true时,未指定position的参数将直接作为 JSON 对象发送到请求体中,并自动添加Content-Type: application/json; charset=utf-8头。requestTemplate:argsToJsonBody: true -
argsToUrlParam: 当设置为
true时,未指定position的参数将作为查询参数添加到 URL 中。requestTemplate:argsToUrlParam: true -
argsToFormBody: 当设置为
true时,未指定position的参数将以application/x-www-form-urlencoded格式编码在请求体中,并自动添加相应的 Content-Type 头。requestTemplate:argsToFormBody: true
这些选项简化了常见 API 调用模式的配置,无需手动构建请求体或 URL 参数。请注意,这四个选项是互斥的,在一个工具配置中只能使用其中一种。如果同时配置了多个选项,系统会报错并拒绝加载该工具配置。
模板语法
REST-to-MCP 功能使用 GJSON Template 库进行模板渲染,它结合了 Go 的模板语法和 GJSON 的强大路径语法:
请求模板
用于构造 HTTP 请求 URL、头部和正文:
- 访问配置值:
.config.字段名 - 访问工具参数:
.args.参数名
响应模板
用于将 HTTP 响应转换为适合 AI 消费的格式:
- 使用 GJSON 路径语法访问 JSON 响应字段
- 使用模板函数如
add、upper、lower等 - 使用控制结构如
if、range等
GJSON Template 包含了所有 Sprig 的函数,提供了 70+ 种用于字符串操作、数学运算、日期格式化等的模板函数,功能等同于 Helm 的模板能力。
常用的 Sprig 函数包括:
- 字符串操作:
trim、upper、lower、replace、plural、nospace - 数学运算:
add、sub、mul、div、max、min - 日期格式化:
now、date、dateInZone、dateModify - 列表操作:
list、first、last、uniq、sortAlpha - 字典操作:
dict、get、set、hasKey、pluck - 流程控制:
ternary、default、empty、coalesce - 类型转换:
toString、toJson、toPrettyJson、toRawJson - 编码/解码:
b64enc、b64dec、urlquery、urlqueryescape - UUID 生成:
uuidv4
有关所有可用函数的完整参考,请参阅 Helm 函数文档,因为 GJSON Template 包含了相同的函数集。
GJSON 路径语法
GJSON 提供了强大的 JSON 查询能力:
- 点表示法:
address.city - 数组索引:
users.0.name - 数组迭代:
users.#.name - 数组过滤:
users.#(age>=30)#.name - 修饰符:
users.@reverse.#.name - 多路径:
{name:users.0.name,count:users.#} - 转义字符:
path.with\.dot
对于更复杂的查询,可以使用 gjson 函数:
<!-- 使用 gjson 函数进行复杂查询 -->活跃用户: {{gjson "users.#(active==true)#.name"}}
<!-- 带有多个条件的数组过滤 -->30岁以上的活跃开发者: {{gjson "users.#(active==true && age>30)#.name"}}
<!-- 使用修饰符 -->用户名(倒序): {{gjson "users.@reverse.#.name"}}
<!-- 迭代过滤结果 -->管理员:{{range $user := gjson "users.#(roles.#(==admin)>0)#"}} - {{$user.name}} ({{$user.age}}){{end}}完整的 GJSON 路径语法参考可查看 GJSON 文档。
配置示例
使用内置 MCP 服务器示例:配置 quark-search
server: name: "quark-search" config: apiKey: "xxxx"此配置使用了 Higress 内置的 quark-search MCP 服务器。在这种情况下,只需要指定服务器名称和必要的配置(如 API 密钥),无需配置 tools 字段,因为工具已经在服务器中预定义好了。
MCP 代理服务器示例:代理到后端 MCP 服务器(StreamableHTTP)
server: name: my-mcpserver-proxy type: mcp-proxy transport: http # 使用 StreamableHTTP 协议 mcpServerURL: "http://backend-mcp.example.com/mcp" timeout: 5000 defaultDownstreamSecurity: # 客户端到网关的默认认证 id: ClientApiKey defaultUpstreamSecurity: # 网关到后端的默认认证 id: BackendApiKey securitySchemes: - id: ClientApiKey type: apiKey in: header name: X-Client-API-Key - id: BackendApiKey type: apiKey in: header name: X-Backend-API-Key defaultCredential: "backend-secret-key"
tools:- name: get-secure-product description: "获取安全产品信息" args: - name: product_id description: "产品ID" type: string required: true requestTemplate: security: # 工具级别的网关到后端认证,覆盖默认配置 id: BackendApiKey credential: "special-key-for-this-tool"此配置创建了一个 MCP 代理服务器,它:
- 使用 StreamableHTTP 协议将客户端的 MCP 请求代理到
http://backend-mcp.example.com/mcp - 使用服务器级别的默认认证配置处理
tools/list等通用请求 - 工具级别的认证配置可以覆盖默认设置
- 支持透明认证和凭证覆盖
MCP 代理服务器示例:使用 SSE 协议
server: name: my-sse-mcpserver-proxy type: mcp-proxy transport: sse # 使用 SSE 协议 mcpServerURL: "http://backend-mcp.example.com" timeout: 10000 # SSE 连接可能需要更长的超时时间 defaultDownstreamSecurity: id: ClientBearer defaultUpstreamSecurity: id: BackendBearer securitySchemes: - id: ClientBearer type: http scheme: bearer - id: BackendBearer type: http scheme: bearer
allowTools:- weather-tool- news-tool此配置创建了一个使用 SSE 协议的 MCP 代理服务器:
- 使用 SSE 流式协议与后端通信,支持实时消息推送
- 自动处理 SSE 连接的生命周期(发现、初始化、通知、工具调用)
- 原始请求头会自动复制到后端调用中
- 支持
allowTools过滤可用工具列表 - 认证头会正确传递到所有 SSE 请求中
MCP 代理服务器高级示例:透明认证
server: name: my-secure-proxy type: mcp-proxy mcpServerURL: "https://api.backend-mcp.com/v1/mcp" timeout: 10000 defaultDownstreamSecurity: # 默认要求客户端提供 Bearer Token id: ClientBearer passthrough: true # 启用透明认证 defaultUpstreamSecurity: # 默认使用透传的凭证调用后端 id: BackendBearer securitySchemes: - id: ClientBearer # 客户端使用 Bearer Token type: http scheme: bearer - id: BackendBearer # 后端也使用 Bearer Token type: http scheme: bearer - id: AdminApiKey # 管理员工具使用特殊 API Key type: apiKey in: header name: X-Admin-Key defaultCredential: "admin-secret-key"
tools:- name: get-user-data description: "获取用户数据(使用透传认证)" args: - name: user_id description: "用户ID" type: string required: true # 此工具使用默认的透传认证,客户端的 Bearer Token 会传递给后端
- name: admin-operation description: "执行管理员操作(使用特殊认证)" security: # 工具级别客户端认证:仍要求客户端提供 Bearer Token id: ClientBearer passthrough: false # 不透传客户端凭证 args: - name: operation description: "操作类型" type: string required: true requestTemplate: security: # 工具级别后端认证:使用管理员 API Key id: AdminApiKey此高级配置展示了:
- 透明认证:
get-user-data工具会将客户端的 Bearer Token 透传给后端 - 混合认证:
admin-operation工具要求客户端认证但使用不同的后端认证 - 服务器级别默认配置:为所有
tools/list请求提供统一的认证策略 - 灵活的认证方案:支持 HTTP Bearer Token 和 API Key 两种认证方式
基础配置示例:转换高德地图 API
server: name: rest-amap-server config: apiKey: your-api-key-heretools:- name: maps-geo description: "将详细的结构化地址转换为经纬度坐标。支持对地标性名胜景区、建筑物名称解析为经纬度坐标" args: - name: address description: "待解析的结构化地址信息" type: string required: true - name: city description: "指定查询的城市" type: string required: false - name: output description: "输出格式" type: string enum: ["json", "xml"] default: "json" requestTemplate: url: "https://restapi.amap.com/v3/geocode/geo" method: GET argsToUrlParam: true headers: - key: x-api-key value: "{{.config.apiKey}}" responseTemplate: body: | # 地理编码信息 {{- range $index, $geo := .geocodes }} ## 地点 {{add $index 1}}
- **国家**: {{ $geo.country }} - **省份**: {{ $geo.province }} - **城市**: {{ $geo.city }} - **城市代码**: {{ $geo.citycode }} - **区/县**: {{ $geo.district }} - **街道**: {{ $geo.street }} - **门牌号**: {{ $geo.number }} - **行政编码**: {{ $geo.adcode }} - **坐标**: {{ $geo.location }} - **级别**: {{ $geo.level }} {{- end }}此配置将高德地图的地理编码 API 转换为 AI 可调用的工具。当 AI 调用此工具时:
- 使用提供的地址和城市参数构建 API 请求
- 调用高德地图 API
- 将 JSON 响应转换为易于阅读的 Markdown 格式
- 将格式化后的结果返回给 AI 助手
高级配置示例:带有条件逻辑的复杂响应处理
server: name: weather-api-server config: apiKey: your-weather-api-keytools:- name: get-weather description: "获取指定城市的天气预报信息" args: - name: city description: "城市名称" type: string required: true - name: days description: "天数(1-7)" type: integer required: false default: 3 - name: include_hourly description: "是否包含每小时预报" type: boolean default: true requestTemplate: url: "https://api.weatherapi.com/v1/forecast.json" method: GET argsToUrlParam: true headers: - key: x-api-key value: "{{.config.apiKey}}" responseTemplate: body: | # {{.location.name}}, {{.location.country}} 天气预报
**当前温度**: {{.current.temp_c}}°C **体感温度**: {{.current.feelslike_c}}°C **天气状况**: {{.current.condition.text}} **湿度**: {{.current.humidity}}% **风速**: {{.current.wind_kph}} km/h
## 未来预报 {{range $index, $day := .forecast.forecastday}} ### {{$day.date}} ({{dateFormat "Monday" $day.date_epoch | title}})
{{if gt $day.day.maxtemp_c 30}}**高温预警!**{{end}} {{if lt $day.day.mintemp_c 0}}**低温预警!**{{end}}
- **最高温度**: {{$day.day.maxtemp_c}}°C - **最低温度**: {{$day.day.mintemp_c}}°C - **降水概率**: {{$day.day.daily_chance_of_rain}}% - **天气状况**: {{$day.day.condition.text}}
#### 分时预报 {{range $hour := slice $day.hour 6 24 3}} - **{{dateFormat "15:04" $hour.time_epoch}}**: {{$hour.temp_c}}°C, {{$hour.condition.text}} {{end}} {{end}}此示例展示了:
- 使用条件语句 (
if) 进行温度警告 - 使用日期格式化函数 (
dateFormat) - 使用数组切片 (
slice) 选择特定时间的天气 - 嵌套循环遍历多天和多时段的天气数据
使用 PrependBody 和 AppendBody 的示例:OpenAPI 转换
当您想保留原始 API 响应但添加额外的上下文信息时,prependBody 和 appendBody 字段非常有用。这在将 OpenAPI/Swagger 规范转换为 MCP 工具时特别有价值,因为您可以保留原始 JSON 响应,同时为 AI 助手提供字段含义的说明。
server: name: product-api-server config: apiKey: your-api-key-heretools:- name: get-product description: "获取产品详细信息" args: - name: product_id description: "产品ID" type: string required: true requestTemplate: url: "https://api.example.com/products/{{.args.product_id}}" method: GET headers: - key: Authorization value: "Bearer {{.config.apiKey}}" responseTemplate: prependBody: | # 产品信息
以下是产品的详细信息,以JSON格式返回。字段说明:
- **id**: 产品唯一标识符 - **name**: 产品名称 - **description**: 产品描述 - **price**: 产品价格(美元) - **category**: 产品类别 - **inventory**: 库存信息 - **quantity**: 当前库存数量 - **warehouse**: 仓库位置 - **ratings**: 用户评分列表 - **score**: 评分(1-5) - **comment**: 评论内容
原始JSON响应:
appendBody: |
您可以使用这些信息来了解产品的详细信息、价格、库存状态和用户评价。此示例展示了:
- 使用
prependBody在原始 JSON 响应前添加字段说明 - 使用
appendBody在响应末尾添加使用建议 - 保留原始 JSON 响应,使 AI 助手可以直接访问所有数据
使用 errorResponseTemplate自定义错误响应的示例
errorResponseTemplate用于在HTTP响应status code>=300 || <200时自定义响应转换模板。支持通过_headers访问map结构的header key value, 以便在errorResponseTemplate中引用header中的值自定义错误响应结果。
server: config: appCode: "" name: "银行卡二三四要素"tools:- args: - description: "银行卡号" name: "cardno" position: "query" required: true type: "string" - description: "姓名(注意UrlEncode编码)" name: "name" position: "query" required: false type: "string" - description: "预留手机号" name: "mobile" position: "query" required: false type: "string" - description: "身份证号码" name: "idcard" position: "query" required: false type: "string" description: "验证卡号、姓名、手机号、证件号是否一致" errorResponseTemplate: |- statusCode: {{gjson "_headers.\\:status"}} errorCode: {{gjson "_headers.x-ca-error-code"}} data: {{.data.value}} name: "银行卡二三四要素验证" requestTemplate: argsToFormBody: false argsToJsonBody: false argsToUrlParam: true method: "GET" url: "https://ckid.market.alicloudapi.com/lundear/verifyBank" responseTemplate: appendBody: |2- - 以下是返回参数说明 - 参数名称: code, 参数类型: integer, 参数描述: 响应状态码 - 参数名称: desc, 参数类型: string, 参数描述: 描述信息 - 参数名称: data, 参数类型: object, 参数描述: 无描述 - 参数名称: data.bankId, 参数类型: string, 参数描述: 银行编码 - 参数名称: data.bankName, 参数类型: string, 参数描述: 银行名称 - 参数名称: data.abbr, 参数类型: string, 参数描述: 银行英文缩写 - 参数名称: data.cardName, 参数类型: string, 参数描述: 卡名称 - 参数名称: data.cardType, 参数类型: string, 参数描述: 卡类型 - 参数名称: data.cardBin, 参数类型: string, 参数描述: 卡bin - 参数名称: data.binLen, 参数类型: integer, 参数描述: 卡bin长度 - 参数名称: data.area, 参数类型: string, 参数描述: 卡所在地区 - 参数名称: data.bankPhone, 参数类型: string, 参数描述: 银行电话 - 参数名称: data.bankUrl, 参数类型: string, 参数描述: 银行网址 - 参数名称: data.bankLogo, 参数类型: string, 参数描述: 银行logo此示例展示了:
- {{gjson “_headers.\:status ”}} -> 访问HTTP响应code
- {{gjson “_headers.x-ca-error-code”}} -> 访问Header中”x-ca-error-code”的值
- {{.data.value}} -> 访问响应体 (e.g., JSON 字段 “data.value”)
AI 提示词生成模板
在与 AI 助手一起生成 REST-to-MCP 配置的模板时,您可以使用以下提示词:
请帮我创建一个 Higress 的 MCP 服务器配置。支持两种类型:1. **REST-to-MCP 服务器**:将 REST API 转换为 MCP 工具2. **MCP 代理服务器**:代理到后端 MCP 服务器
## 配置格式
### REST-to-MCP 服务器配置
```yamlserver: name: rest-api-server type: rest # 可选,默认为 rest config: apiKey: 您的API密钥 # 服务器级别默认认证(可选) defaultDownstreamSecurity: id: ClientAuth defaultUpstreamSecurity: id: BackendAuth securitySchemes: - id: ClientAuth type: http scheme: bearer - id: BackendAuth type: apiKey in: header name: X-API-Key defaultCredential: 您的后端API密钥tools:- name: tool-name description: "详细描述这个工具的功能" security: # 工具级别客户端认证(可选,覆盖服务器默认) id: ClientAuth passthrough: true # 启用透明认证 args: - name: arg1 description: "参数1的描述" type: string # 可选类型: string, number, integer, boolean, array, object required: true position: path # 可选位置: query, path, header, cookie, body - name: arg2 description: "参数2的描述" type: integer required: false default: 10 position: query requestTemplate: url: "https://api.example.com/endpoint" method: POST security: # 工具级别后端认证(可选,覆盖服务器默认) id: BackendAuth credential: "特定工具的凭证" # 可选,覆盖默认凭证 # 以下四个选项互斥,只能选择其中一种 argsToUrlParam: true # 将参数添加到URL查询参数 # 或者其他选项... headers: - key: x-api-key value: "{{.config.apiKey}}" responseTemplate: body: | # 结果 {{- range $index, $item := .items }} ## 项目 {{add $index 1}} - **名称**: {{ $item.name }} - **值**: {{ $item.value }} {{- end }}MCP 代理服务器配置
StreamableHTTP 协议
server: name: mcp-proxy-server type: mcp-proxy transport: http # StreamableHTTP 协议 mcpServerURL: "http://backend-mcp.example.com/mcp" # 后端 MCP 服务器 URL timeout: 5000 # 超时时间(毫秒) # 服务器级别默认认证(推荐配置) defaultDownstreamSecurity: # 客户端到网关认证 id: ClientAuth passthrough: true # 启用透明认证 defaultUpstreamSecurity: # 网关到后端认证 id: BackendAuth securitySchemes: - id: ClientAuth type: http scheme: bearer - id: BackendAuth type: apiKey in: header name: X-Backend-Key defaultCredential: "后端服务密钥"
# 对于 MCP 代理,tools 配置是可选的# 如果配置了 tools,则只有列出的工具可用# 如果不配置 tools,则代理所有后端 MCP 服务器的工具tools:- name: specific-tool description: "特定工具的配置(可选)" security: # 覆盖默认的客户端认证 id: ClientAuth passthrough: false # 不透传 args: - name: param1 description: "参数描述" type: string required: true requestTemplate: security: # 覆盖默认的后端认证 id: BackendAuth credential: "特定工具的后端凭证"SSE 协议
server: name: mcp-sse-proxy-server type: mcp-proxy transport: sse # SSE 协议 mcpServerURL: "http://backend-mcp.example.com" # 后端 MCP 服务器基础 URL timeout: 10000 # SSE 通常需要更长的超时时间 # 服务器级别默认认证 defaultDownstreamSecurity: id: ClientBearer defaultUpstreamSecurity: id: BackendBearer securitySchemes: - id: ClientBearer type: http scheme: bearer - id: BackendBearer type: http scheme: bearer defaultCredential: "后端Bearer Token"
# 可选:限制允许的工具allowTools:- tool1- tool2模板语法
模板使用 GJSON Template 语法 (https://github.com/higress-group/gjson_template),该语法结合了 Go 模板和 GJSON 路径语法进行 JSON 处理。模板引擎支持:
- 基本点表示法访问字段:{{.fieldName}}
- 用于复杂查询的 gjson 函数:{{gjson “users.#(active==true)#.name”}}
- 所有 Sprig 模板函数(类似 Helm):{{add}}、{{upper}}、{{lower}}、{{date}} 等
- 控制结构:{{if}}、{{range}}、{{with}} 等
- 变量赋值:{{$var := .value}}
对于复杂的 JSON 响应,请考虑使用 GJSON 强大的过滤和查询能力来提取和格式化最相关的信息。
我的需求
请选择您的需求类型:
如果要转换 REST API 为 MCP 工具
请描述您的 REST API:
- API 端点 URL
- 认证方式(API Key、Bearer Token 等)
- 参数和响应格式
- 或者粘贴 Swagger/OpenAPI 规范
如果要代理现有的 MCP 服务器
请提供:
- 后端 MCP 服务器的 URL
- 传输协议类型(StreamableHTTP 或 SSE)
- 认证要求(客户端认证、后端认证)
- 是否需要透明认证(将客户端凭证传递给后端)
- 是否需要限制可用工具(allowTools)
- 特定工具的配置需求
[在此描述您的具体需求]
## 生成要求
请根据以上信息生成一个完整的配置,包括:
### 对于 REST-to-MCP 服务器:1. 具有描述性名称和适当的服务器配置2. 定义所有必要的参数,并提供清晰的描述和适当的类型、必填/默认值3. 选择合适的参数传递方式(argsToUrlParam、argsToJsonBody、argsToFormBody 或自定义 body)4. 创建将 API 响应转换为适合 AI 消费的可读格式的 responseTemplate5. 配置适当的认证方案和安全配置
### 对于 MCP 代理服务器:1. 选择合适的传输协议(`http` 用于 StreamableHTTP,`sse` 用于 SSE)2. 配置后端 MCP 服务器 URL 和超时时间(SSE 建议使用更长的超时时间)3. 设置服务器级别的默认认证配置4. 根据需要配置透明认证5. 配置 `allowTools` 以限制可用工具(可选)6. 如有特殊需求,配置特定工具的认证覆盖7. 确保客户端到网关和网关到后端的认证链路完整