[feat] mcp streamable http#6061

ZWJzhangwanjie · 2025-07-20T10:19:44Z

[feat] mcp streamable http

Make sure that:

[Y] You have read the contribution guidelines.
[Y] You submit test cases (unit or integration tests) that back your changes.
[Y] Your local test passed ./mvnw clean install -Dmaven.javadoc.skip=true.

how to use mcp plugin ?
https://o6qjqhqozq.feishu.cn/docx/HXgEdSf1SoAjZKxsN4GcIjPTnYb?from=from_copylink

what is the architectural design for mcp
https://o6qjqhqozq.feishu.cn/docx/HFfwd66Hbosvznx0G2hc5fFynec?from=from_copylink

…syncServer.

…support for Streamable http.

…ssion support for Streamable http.

…yuToolCallback .

…ssage endpoint.

…rtMap & streamableHttpTransportMap.

Copilot

Pull Request Overview

This PR introduces support for Streamable HTTP transport protocol to the MCP (Model Context Protocol) server plugin, expanding beyond the existing SSE (Server-Sent Events) protocol. The implementation provides a unified architecture where both SSE and Streamable HTTP protocols share the same MCP server instance per path, enabling AI models to interact with Shenyu Gateway services through multiple transport protocols.

Enhanced MCP server manager with shared server instances supporting multiple transport protocols
Added Streamable HTTP transport provider with session management and automatic recovery capabilities
Improved parameter handling and response processing with protocol-specific decorators

Reviewed Changes

Copilot reviewed 12 out of 12 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
JsonSchemaUtil.java	Fixed parameter type handling to use actual parameter type instead of hardcoded "string"
ShenyuStreamableHttpServerTransportProvider.java	New transport provider implementing Streamable HTTP protocol with comprehensive session management
NonCommittingMcpResponseDecorator.java	New response decorator for Streamable HTTP that captures responses without committing to original response
RequestConfigHelper.java	Refactored path building logic with improved URL handling and removed unused methods
ParameterFormatter.java	New utility for JSON parameter formatting and type conversion
BodyWriterExchange.java	Enhanced request body handling using cached output messages
ShenyuMcpServerManager.java	Major refactor to support shared servers across multiple transport protocols
McpServerPluginDataHandler.java	Added default message endpoint configuration
ShenyuToolCallback.java	Enhanced tool callback with protocol-aware processing and improved session management
McpServerPlugin.java	Updated plugin to route requests based on protocol type (SSE vs Streamable HTTP)
MCP_TOOL_EXAMPLES_EN.md	New comprehensive examples documentation in English
MCP_TOOL_EXAMPLES.md	New comprehensive examples documentation in Chinese

Comments suppressed due to low confidence (1)

shenyu-plugin/shenyu-plugin-mcp-server/src/main/java/org/apache/shenyu/plugin/mcp/server/callback/ShenyuToolCallback.java:209

Similar Javadoc formatting issue. The description should follow proper Javadoc formatting conventions.

        final ServerWebExchange decoratedExchange = buildDecoratedExchange(

Copilot · 2025-07-21T03:10:01Z

...g/apache/shenyu/plugin/mcp/server/transport/ShenyuStreamableHttpServerTransportProvider.java

+            }
+        }
+    }
+}


This file is extremely large (1257 lines) which makes it difficult to maintain and understand. Consider breaking it down into smaller, more focused classes such as separate classes for session management, message handling, and transport operations.

I have separated it into multiple classes to ensure it is under 1,000 lines

Copilot · 2025-07-21T03:10:02Z

...g/apache/shenyu/plugin/mcp/server/transport/ShenyuStreamableHttpServerTransportProvider.java

+                    builder.header(SESSION_ID_HEADER, result.getSessionId());
+                }
+
+                // 统一使用 application/json 格式返回响应


Comments should be in English to maintain consistency with the rest of the codebase. This Chinese comment should be translated.

Suggested change

// 统一使用 application/json 格式返回响应

// Use application/json format uniformly for the response

Copilot · 2025-07-21T03:10:02Z

...cp-server/src/main/java/org/apache/shenyu/plugin/mcp/server/request/RequestConfigHelper.java

-                    return value;
-                }
-            }
+        // 首先检查输入值是否已经是一个完整的 URL


Comments should be in English to maintain consistency with the rest of the codebase. Multiple Chinese comments throughout this file should be translated.

Suggested change

// 首先检查输入值是否已经是一个完整的 URL

// First, check if the input value is already a complete URL

Copilot · 2025-07-21T03:10:02Z

...ain/java/org/apache/shenyu/plugin/mcp/server/response/NonCommittingMcpResponseDecorator.java

+
+    /**
+     * Processes response data by applying response template transformations.
+          * If no response template is configured, returns the original response body unchanged.


The Javadoc formatting is incorrect. The description should start on the same line as the opening /** or use proper line continuation with proper indentation.

Suggested change

* If no response template is configured, returns the original response body unchanged.

* If no response template is configured, returns the original response body unchanged.

Copilot · 2025-07-21T03:10:03Z

...ain/java/org/apache/shenyu/plugin/mcp/server/response/NonCommittingMcpResponseDecorator.java

+
+    /**
+     * Applies placeholder substitution to a text template using response data.
+          * Supports simple placeholder format: ${fieldName}


Similar Javadoc formatting issue. The description should follow proper Javadoc formatting conventions.

Suggested change

* Supports simple placeholder format: ${fieldName}

* Supports simple placeholder format: ${fieldName}

Copilot · 2025-07-21T03:10:03Z

...nyu-plugin-mcp-server/src/main/java/org/apache/shenyu/plugin/mcp/server/McpServerPlugin.java

    /**
-     * Extract sessionId from request parameters or headers.
+     * Extracts session ID from request parameters or headers.
+          * Searches in the following order:


Similar Javadoc formatting issue. The description should follow proper Javadoc formatting conventions.

Suggested change

* Searches in the following order:

* Searches in the following order:

Aias00 · 2025-07-21T06:18:51Z

...cp-server/src/main/java/org/apache/shenyu/plugin/mcp/server/request/RequestConfigHelper.java

-
-        // handle new query parameters
+
+        // 处理新的查询参数


change Chinese to English pls

Aias00 · 2025-07-21T06:19:19Z

...cp-server/src/main/java/org/apache/shenyu/plugin/mcp/server/request/RequestConfigHelper.java

+        // 处理新的查询参数
+        basePath = processArguments(argsPosition, inputJson, basePath, queryBuilder);
+
+        // 清理未替换的模板变量


Aias00 · 2025-07-21T06:19:38Z

...cp-server/src/main/java/org/apache/shenyu/plugin/mcp/server/request/RequestConfigHelper.java

            } else if ("query".equals(position) && inputJson.has(key)) {
-                // handle query parameters
-                if (!existingQuery.contains(key + "=")) {
+                // 处理查询参数


Aias00 · 2025-07-21T06:19:49Z

...cp-server/src/main/java/org/apache/shenyu/plugin/mcp/server/request/RequestConfigHelper.java

-        
-        // add new query parameters if any
+
+        // 添加查询参数


Yes , I'm dealing with it

ZWJzhangwanjie added 16 commits July 17, 2025 20:16

[feat] mcp server plugin, init to support streamable http.

ebeb448

[feat] mcp server plugin, let streamable http and sse use single McpA…

de14ccf

…syncServer.

[feat] mcp server plugin, remove default tool for McpAsyncServer.

4ca8325

[feat] mcp server plugin, session reconnection and stateless session …

be8baba

…support for Streamable http.

[feat] mcp server plugin, debug session reconnection and stateless se…

5d9ab46

…ssion support for Streamable http.

[feat] mcp server plugin, Remove handle noSessionId exchange for Shen…

28f98b9

…yuToolCallback .

[feat] mcp server plugin, Add tools config examples .

45867b5

[feat] mcp server plugin, Modify Body writer for POST request .

a900abb

[feat] mcp server plugin, Modify rpc type when need do call.

0bd3e05

[feat] mcp server plugin, Modify parameter format & support grpc.

09c88eb

[feat] mcp server plugin, fix streamable http after support custom me…

f469819

…ssage endpoint.

[feat] mcp server plugin, Modify javadoc for more.

1048230

Merge branch 'master' of https://github.com/apache/shenyu

4e19718

[feat] mcp server plugin, fix check style.

e0810cb

[feat] mcp server plugin, use compositeTransportMap remove sseTranspo…

ae98824

…rtMap & streamableHttpTransportMap.

[feat] mcp server plugin, reuse ObjectMapper & remove protocolMap.

fe729d9

ZWJzhangwanjie changed the title ~~Feat mcp streamable http~~ [feat] mcp streamable http Jul 20, 2025

Aias00 requested a review from Copilot July 21, 2025 03:08

Copilot AI reviewed Jul 21, 2025

View reviewed changes

Aias00 requested changes Jul 21, 2025

View reviewed changes

[feat] mcp server plugin, fix mistakes for Copilot check.

4fbd8c7

ZWJzhangwanjie requested a review from Aias00 July 21, 2025 07:38

Aias00 approved these changes Jul 21, 2025

View reviewed changes

Aias00 merged commit 7de2558 into apache:master Jul 21, 2025
45 checks passed

Aias00 added this to the 2.7.0.2 milestone Jul 28, 2025

+                          }
+                      }
+                  }
+              }

                
                    No newline at end of file

	// 统一使用 application/json 格式返回响应
	// Use application/json format uniformly for the response

	// 首先检查输入值是否已经是一个完整的 URL
	// First, check if the input value is already a complete URL

	* If no response template is configured, returns the original response body unchanged.
	* If no response template is configured, returns the original response body unchanged.

	* Supports simple placeholder format: ${fieldName}
	* Supports simple placeholder format: ${fieldName}

	* Searches in the following order:
	* Searches in the following order:

Conversation

ZWJzhangwanjie commented Jul 20, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Jul 21, 2025

Choose a reason for hiding this comment

Uh oh!

ZWJzhangwanjie Jul 21, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 21, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 21, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 21, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 21, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Jul 21, 2025

Choose a reason for hiding this comment

Uh oh!

Aias00 Jul 21, 2025

Choose a reason for hiding this comment

Uh oh!

Aias00 Jul 21, 2025

Choose a reason for hiding this comment

Uh oh!

Aias00 Jul 21, 2025

Choose a reason for hiding this comment

Uh oh!

Aias00 Jul 21, 2025

Choose a reason for hiding this comment

Uh oh!

ZWJzhangwanjie Jul 21, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ZWJzhangwanjie commented Jul 20, 2025 •

edited

Loading