feat: add sync mcp servers (#240)

Author: Han-Ya-Jun

sdks/apigw-manager/bin/sync-apigateway.sh

@@ -24,4 +24,10 @@ call_command_or_warning fetch_esb_public_key ${FETCH_ESB_PUBLIC_KEY_ARGS}
 title "releasing"
 call_definition_command_or_exit create_version_and_release_apigw "${definition_file}" ${CREATE_VERSION_AND_RELEASE_APIGW_ARGS:-"--generate-sdks"}
 
+
+if [[ "${ENABLE_SYNC_MCP_SERVERS}" = "true" ]]; then
+    title "syncing stage MCP Servers"
+    call_definition_command_or_exit sync_apigw_stage_mcp_servers "${definition_file}"
+fi
+
 log_info "done"

sdks/apigw-manager/docs/sync-apigateway-with-django.md

@@ -46,6 +46,9 @@ python manage.py sync_resource_docs_by_archive --gateway-name=${gateway_name} --
 # 指定参数 --no-pub 则只生成版本，不发布
 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}"
 
@@ -80,6 +83,7 @@ class Command(BaseCommand):
         call_command("sync_apigw_resources", f"--gateway-name={gateway_name}", "--delete", f"--file={resources_path}")
         call_command("sync_resource_docs_by_archive", f"--gateway-name={gateway_name}", f"--file={definition_path}")
         call_command("create_version_and_release_apigw", f"--gateway-name={gateway_name}", f"--file={definition_path}")
+        call_command("sync_apigw_stage_mcp_servers", f"--gateway-name={gateway_name}", f"--file={definition_path}")
         call_command("grant_apigw_permissions", f"--gateway-name={gateway_name}", f"--file={definition_path}")
         call_command("fetch_apigw_public_key", f"--gateway-name={gateway_name}")
 ```
@@ -162,6 +166,9 @@ python manage.py apply_apigw_permissions --gateway-name=${gateway_name} --file="
 # 指定参数 --no-pub 则只生成版本，不发布
 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 fetch_apigw_public_key --gateway-name=${gateway_name}
 

sdks/apigw-manager/docs/sync-apigateway-with-docker.md

@@ -32,6 +32,7 @@
 - `SYNC_APIGW_RESOURCES_ARGS`: 默认值："--delete"，用于命令 `sync_apigw_resources`，同步网关资源
 - `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
 
 基础镜像提供了一些自定义同步脚本常用的 bash 函数，以及执行 Django Command 指令的辅助脚本：
 

sdks/apigw-manager/docs/sync_apigateway.md

@@ -100,6 +100,22 @@ stages:
           hosts:
             - host: "http://httpbin.org"
               weight: 100
+#  同步 MCP Server 相关配置
+#    mcp_servers:
+#      - name: "mcp_server1",
+#        description: "mcp-server demo"
+#        labels: 
+#          - "test"
+#        # 添加的tool对应的资源名称
+#        resource_names:
+#          - resource1
+#        # 是否公开
+#        is_public: true
+#        # 1: 开启,0: 停止; 默认是开启
+#        status: 1
+#        # 授权的应用
+#        target_app_codes:
+#          - "bk_app_code1"
 ```
 
 > 📢 注意：如果之前接入过的，建议将 spec_version 改成 2，并将原先 `stage:{}`改成 `stages: []`
@@ -164,6 +180,22 @@ stages:
         hosts:
           - host: ""
             weight: 100
+    #  同步 MCP Server 相关配置
+    # mcp_servers:
+    #  - name: "mcp_server1"
+    #    description: "mcp-server demo"
+    #    labels: 
+    #      - "test"
+    #    # 添加的tool对应的资源名称
+    #    resource_names:
+    #      - resource1
+    #    # 是否公开
+    #    is_public: true
+    #    # 1: 开启,0: 停止；默认是开启
+    #    status: 1
+    #    # 授权的应用
+    #     target_app_codes:
+    #       - "bk_app_code1"
 
     # 环境插件配置
     # plugin_configs:
@@ -251,6 +283,7 @@ x-bk-apigateway-resource:
   isPublic: true   # 是否公开，公开，则用户可查看资源文档、申请资源权限；不公开，则资源对用户隐藏
   allowApplyPermission: false # 是否允许用户申请资源权限，允许，则任何蓝鲸应用可在蓝鲸开发者中心申请资源的访问权限；否则，只能通过网关管理员主动授权为某应用添加权限
   matchSubpath: false # 匹配所有子路径
+  noneSchema: true # 是否有请求参数：对于需要添加的 MCP Server 的资源如果没有请求参数(body,path,header,query)一定要显示配置才行
   backend:
     type: HTTP
     method: get

sdks/apigw-manager/examples/chart/use-configmap/files/support-files/bin/sync-apigateway.sh

@@ -30,4 +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_SYNC_MCP_SERVERS}" = "true" ]]; then
+    title "syncing stage MCP Servers"
+    call_definition_command_or_exit sync_apigw_stage_mcp_servers "${definition_file}"
+fi
+
+log_info "done"

sdks/apigw-manager/examples/chart/use-custom-docker-image/my-apigw-manager/support-files/bin/sync-apigateway.sh

@@ -31,3 +31,10 @@ title "releasing"
 call_definition_command_or_exit create_version_and_release_apigw "${definition_file}" --gateway-name=${gateway_name}
 
 title "done"
+
+if [[ "${ENABLE_MCP_SERVER}" = "true" ]]; then
+    title "syncing stage MCP Servers"
+    call_definition_command_or_exit sync_apigw_stage_mcp_servers "${definition_file}"
+fi
+
+log_info "done"