From a37b4645ffe527b56c9ac1c5ee71f61e75e18d6a Mon Sep 17 00:00:00 2001 From: Han-Ya-Jun <1581532052@qq.com> Date: Wed, 4 Mar 2026 11:57:27 +0800 Subject: [PATCH] =?UTF-8?q?feat(apigw-manager):=20=E8=A1=A5=E5=85=85=20MCP?= =?UTF-8?q?=20Server=20=E5=90=8C=E6=AD=A5=E7=9B=B8=E5=85=B3=E6=96=87?= =?UTF-8?q?=E6=A1=A3=E3=80=81=E8=84=9A=E6=9C=AC=E5=92=8C=E9=85=8D=E7=BD=AE?= =?UTF-8?q?=E6=A0=B7=E4=BE=8B?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - bin/sync-apigateway.sh 支持通过 SYNC_APIGW_STAGE_MCP_SERVERS_ARGS 传递额外参数 - docs/sync-apigateway-with-docker.md 补充 MCP Server 同步命令说明及环境变量 - examples 中 definition.yaml 添加 mcp_servers 配置样例（含 title、protocol_type 参数） - examples 中 sync-apigateway.sh 脚本添加 MCP Server 同步步骤 - 统一环境变量名为 ENABLE_SYNC_MCP_SERVERS - CHANGE.md 补充 MCP Server 同步相关变更日志 --- sdks/apigw-manager/CHANGE.md | 7 ++++++ sdks/apigw-manager/bin/sync-apigateway.sh | 2 +- .../docs/sync-apigateway-with-docker.md | 7 ++++++ .../support-files/bin/sync-apigateway.sh | 2 +- .../files/support-files/definition.yaml | 22 +++++++++++++++++++ .../support-files/bin/sync-apigateway.sh | 6 ++--- .../support-files/definition.yaml | 21 ++++++++++++++++++ .../support-files/bin/sync-apigateway.sh | 4 ++++ .../support-files/definition.yaml | 21 ++++++++++++++++++ 9 files changed, 86 insertions(+), 6 deletions(-) diff --git a/sdks/apigw-manager/CHANGE.md b/sdks/apigw-manager/CHANGE.md index 26a07510..89af3872 100644 --- a/sdks/apigw-manager/CHANGE.md +++ b/sdks/apigw-manager/CHANGE.md @@ -1,5 +1,12 @@ ## Change logs +### 4.2.3 + +- 支持同步网关环境 MCP Server 配置，新增 Django Command `sync_apigw_stage_mcp_servers` +- 基础镜像 sync-apigateway.sh 支持通过环境变量 `ENABLE_SYNC_MCP_SERVERS=true` 开启 MCP Server 同步 +- DRF 集成支持 MCP Server 配置生成与同步（`gen_apigateway_resource_config` 新增 `enable_mcp`/`none_schema` 参数） +- 完善 examples 中的 definition.yaml 和 sync-apigateway.sh 样例，添加 MCP Server 配置示例 + ### 4.1.0 - [breaking change] 做了多租户改造的全租户应用必须显式设置 `BK_APP_TENANT_ID=system` (环境变量或django settings) diff --git a/sdks/apigw-manager/bin/sync-apigateway.sh b/sdks/apigw-manager/bin/sync-apigateway.sh index de3bbcf0..3bdd5c89 100755 --- a/sdks/apigw-manager/bin/sync-apigateway.sh +++ b/sdks/apigw-manager/bin/sync-apigateway.sh @@ -27,7 +27,7 @@ call_definition_command_or_exit create_version_and_release_apigw "${definition_f if [[ "${ENABLE_SYNC_MCP_SERVERS}" = "true" ]]; then title "syncing stage MCP Servers" - call_definition_command_or_exit sync_apigw_stage_mcp_servers "${definition_file}" + call_definition_command_or_exit sync_apigw_stage_mcp_servers "${definition_file}" ${SYNC_APIGW_STAGE_MCP_SERVERS_ARGS} fi log_info "done" diff --git a/sdks/apigw-manager/docs/sync-apigateway-with-docker.md b/sdks/apigw-manager/docs/sync-apigateway-with-docker.md index e06507e5..0352d7ba 100644 --- a/sdks/apigw-manager/docs/sync-apigateway-with-docker.md +++ b/sdks/apigw-manager/docs/sync-apigateway-with-docker.md @@ -33,6 +33,7 @@ - `SYNC_RESOURCE_DOCS_BY_ARCHIVE_ARGS`: 默认值： "--safe-mode"，用于命令 `sync_resource_docs_by_archive`，同步网关文档 - `CREATE_VERSION_AND_RELEASE_APIGW_ARGS`: 默认值："--generate-sdks"，用于命令 `create_version_and_release_apigw`,创建资源版本并发布 - `ENABLE_SYNC_MCP_SERVERS`: 用于命令 `sync_apigw_stage_mcp_servers`, 是否开启同步环境 MCP Server +- `SYNC_APIGW_STAGE_MCP_SERVERS_ARGS`: 用于命令 `sync_apigw_stage_mcp_servers`，同步环境 MCP Server 的额外参数 基础镜像提供了一些自定义同步脚本常用的 bash 函数，以及执行 Django Command 指令的辅助脚本： @@ -87,6 +88,9 @@ title "releasing" # 指定参数 --no-pub 则只生成版本，不发布 call_definition_command_or_exit create_version_and_release_apigw "${definition_file}" --gateway-name=${gateway_name} +# 可选：需要同步 MCP Server 时调用。注意：前提是该 stage 有生效的版本且声明的 mcp tool 在生效版本的资源列表里且确认过请求参数 +# call_definition_command_or_exit sync_apigw_stage_mcp_servers "${definition_file}" --gateway-name=${gateway_name} + log_info "done" ``` @@ -314,4 +318,7 @@ call_definition_command_or_exit sync_apigw_stage "${definition_file}" --gateway- # 可选，同步资源文档 call_definition_command_or_exit sync_resource_docs_by_archive "${definition_file}" --gateway-name=${gateway_name} --safe-mode + +# 可选：需要同步 MCP Server 时调用。注意：前提是该 stage 有生效的版本且声明的 mcp tool 在生效版本的资源列表里且确认过请求参数 +# call_definition_command_or_exit sync_apigw_stage_mcp_servers "${definition_file}" --gateway-name=${gateway_name} ``` diff --git a/sdks/apigw-manager/examples/chart/use-configmap/files/support-files/bin/sync-apigateway.sh b/sdks/apigw-manager/examples/chart/use-configmap/files/support-files/bin/sync-apigateway.sh index 67e8dcaf..73978647 100755 --- a/sdks/apigw-manager/examples/chart/use-configmap/files/support-files/bin/sync-apigateway.sh +++ b/sdks/apigw-manager/examples/chart/use-configmap/files/support-files/bin/sync-apigateway.sh @@ -32,7 +32,7 @@ call_definition_command_or_exit create_version_and_release_apigw "${definition_f if [[ "${ENABLE_SYNC_MCP_SERVERS}" = "true" ]]; then title "syncing stage MCP Servers" - call_definition_command_or_exit sync_apigw_stage_mcp_servers "${definition_file}" + call_definition_command_or_exit sync_apigw_stage_mcp_servers "${definition_file}" --gateway-name=${gateway_name} fi log_info "done" \ No newline at end of file diff --git a/sdks/apigw-manager/examples/chart/use-configmap/files/support-files/definition.yaml b/sdks/apigw-manager/examples/chart/use-configmap/files/support-files/definition.yaml index ac5dc984..23b49219 100644 --- a/sdks/apigw-manager/examples/chart/use-configmap/files/support-files/definition.yaml +++ b/sdks/apigw-manager/examples/chart/use-configmap/files/support-files/definition.yaml @@ -26,6 +26,28 @@ stages: # 网关调用后端服务的默认域名或IP，不包含Path，比如：http://api.example.com - host: "https://httpbin.org" weight: 100 + + # 同步 MCP Server 相关配置（可选） + # mcp_servers: + # - name: "mcp_server1" + # # MCP Server 中文名/显示名称 + # title: "MCP Server 示例" + # description: "mcp-server demo" + # labels: + # - "test" + # # 添加的 tool 对应的资源名称 + # resource_names: + # - resource1 + # # 是否公开 + # is_public: true + # # 1: 开启, 0: 停止; 默认是开启 + # status: 1 + # # MCP 协议类型: sse（默认）、streamable_http + # protocol_type: "sse" + # # 授权的应用 + # target_app_codes: + # - "bk_app_code1" + # 环境插件配置 # plugin_configs: # - type: bk-rate-limit diff --git a/sdks/apigw-manager/examples/chart/use-custom-docker-image/my-apigw-manager/support-files/bin/sync-apigateway.sh b/sdks/apigw-manager/examples/chart/use-custom-docker-image/my-apigw-manager/support-files/bin/sync-apigateway.sh index b02c979e..ed69dd07 100755 --- a/sdks/apigw-manager/examples/chart/use-custom-docker-image/my-apigw-manager/support-files/bin/sync-apigateway.sh +++ b/sdks/apigw-manager/examples/chart/use-custom-docker-image/my-apigw-manager/support-files/bin/sync-apigateway.sh @@ -30,11 +30,9 @@ title "releasing" # 指定参数 --no-pub 则只生成版本，不发布 call_definition_command_or_exit create_version_and_release_apigw "${definition_file}" --gateway-name=${gateway_name} -title "done" - -if [[ "${ENABLE_MCP_SERVER}" = "true" ]]; then +if [[ "${ENABLE_SYNC_MCP_SERVERS}" = "true" ]]; then title "syncing stage MCP Servers" - call_definition_command_or_exit sync_apigw_stage_mcp_servers "${definition_file}" + call_definition_command_or_exit sync_apigw_stage_mcp_servers "${definition_file}" --gateway-name=${gateway_name} fi log_info "done" \ No newline at end of file diff --git a/sdks/apigw-manager/examples/chart/use-custom-docker-image/my-apigw-manager/support-files/definition.yaml b/sdks/apigw-manager/examples/chart/use-custom-docker-image/my-apigw-manager/support-files/definition.yaml index e059acd1..3ff2a54e 100644 --- a/sdks/apigw-manager/examples/chart/use-custom-docker-image/my-apigw-manager/support-files/definition.yaml +++ b/sdks/apigw-manager/examples/chart/use-custom-docker-image/my-apigw-manager/support-files/definition.yaml @@ -27,6 +27,27 @@ stages: - host: "https://httpbin.org" weight: 100 + # 同步 MCP Server 相关配置（可选） + # mcp_servers: + # - name: "mcp_server1" + # # MCP Server 中文名/显示名称 + # title: "MCP Server 示例" + # description: "mcp-server demo" + # labels: + # - "test" + # # 添加的 tool 对应的资源名称 + # resource_names: + # - resource1 + # # 是否公开 + # is_public: true + # # 1: 开启, 0: 停止; 默认是开启 + # status: 1 + # # MCP 协议类型: sse（默认）、streamable_http + # protocol_type: "sse" + # # 授权的应用 + # target_app_codes: + # - "bk_app_code1" + # 环境插件配置 # plugin_configs: # - type: bk-rate-limit diff --git a/sdks/apigw-manager/examples/django/use-custom-script/support-files/bin/sync-apigateway.sh b/sdks/apigw-manager/examples/django/use-custom-script/support-files/bin/sync-apigateway.sh index f6b4f7f3..94714150 100755 --- a/sdks/apigw-manager/examples/django/use-custom-script/support-files/bin/sync-apigateway.sh +++ b/sdks/apigw-manager/examples/django/use-custom-script/support-files/bin/sync-apigateway.sh @@ -23,6 +23,10 @@ python manage.py sync_apigw_stage --gateway-name=${gateway_name} --file="${defin python manage.py sync_apigw_resources --delete --gateway-name=${gateway_name} --file="${resources_file}" python manage.py sync_resource_docs_by_archive --gateway-name=${gateway_name} --file="${definition_file}" python manage.py create_version_and_release_apigw --gateway-name=${gateway_name} --file="${definition_file}" + +# 可选：需要同步 MCP Server 时调用。注意：前提是该 stage 有生效的版本且声明的 mcp tool 在生效版本的资源列表里且确认过请求参数 +# python manage.py sync_apigw_stage_mcp_servers --gateway-name=${gateway_name} --file="${definition_file}" + python manage.py grant_apigw_permissions --gateway-name=${gateway_name} --file="${definition_file}" python manage.py fetch_apigw_public_key --gateway-name=${gateway_name} echo "gateway ${gateway_name} sync definition end" diff --git a/sdks/apigw-manager/examples/django/use-custom-script/support-files/definition.yaml b/sdks/apigw-manager/examples/django/use-custom-script/support-files/definition.yaml index 444efe01..a1b57bfb 100644 --- a/sdks/apigw-manager/examples/django/use-custom-script/support-files/definition.yaml +++ b/sdks/apigw-manager/examples/django/use-custom-script/support-files/definition.yaml @@ -27,6 +27,27 @@ stages: - host: "https://httpbin.org" weight: 100 + # 同步 MCP Server 相关配置（可选） + # mcp_servers: + # - name: "mcp_server1" + # # MCP Server 中文名/显示名称 + # title: "MCP Server 示例" + # description: "mcp-server demo" + # labels: + # - "test" + # # 添加的 tool 对应的资源名称 + # resource_names: + # - resource1 + # # 是否公开 + # is_public: true + # # 1: 开启, 0: 停止; 默认是开启 + # status: 1 + # # MCP 协议类型: sse（默认）、streamable_http + # protocol_type: "sse" + # # 授权的应用 + # target_app_codes: + # - "bk_app_code1" + # 资源文档 # 资源文档的目录格式样例如下，en 为英文文档，zh 为中文文档： # ./