[feat]: shenyu mcp plugin auto register#6163

478320 · 2025-09-16T15:02:25Z

Make sure that:

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

478320 · 2025-09-16T15:07:33Z

Copilot

Pull Request Overview

This PR introduces ShenYu MCP (Message Communication Protocol) plugin auto-registration functionality, enabling automatic service discovery and registration for MCP tools and services.

Add complete MCP client and server-side auto-registration infrastructure
Implement OpenAPI-based MCP tool configuration and metadata generation
Create comprehensive example application demonstrating MCP integration

Reviewed Changes

Copilot reviewed 40 out of 40 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
shenyu-spring-boot-starter/shenyu-spring-boot-starter-client/shenyu-spring-boot-starter-client-mcp/	Spring Boot starter module for MCP client integration
shenyu-register-center/	Core registration DTOs and client repository support for MCP tools
shenyu-examples/shenyu-examples-mcp/	Example application showcasing MCP plugin usage
shenyu-common/	Added MCP RPC type enum and plugin name adapter support
shenyu-client/shenyu-client-mcp/	Complete MCP client implementation with OpenAPI generators
shenyu-admin/	Server-side MCP registration service and controller endpoints

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

.../main/java/org/apache/shenyu/springboot/starter/client/mcp/ShenyuMcpClientConfiguration.java

Copilot · 2025-09-17T07:46:26Z

...ient-api/src/main/java/org/apache/shenyu/register/client/api/FailbackRegistryRepository.java

+            this.doPersistMcpTools(registerDTO);
+        } catch (Exception ex) {
+            logger.warn("Failed to persistMcpTools {}, cause:{}", registerDTO, ex.getMessage());
+            this.addFailureApiDocRegister(registerDTO);


The method call addFailureApiDocRegister(registerDTO) should be addFailureMcpToolsRegister(registerDTO) to properly handle MCP tools registration failures, not API doc registration failures.

hi, this suggestion is right, u should do this

...lient-mcp/src/main/java/org/apache/shenyu/client/mcp/common/annotation/OpenApiParameter.java

Copilot · 2025-09-17T07:46:27Z

shenyu-common/src/main/java/org/apache/shenyu/common/constant/Constants.java

+    String MCP_TOOLS_TYPE = "mcp";



There is trailing whitespace after the constant declaration. This should be removed to maintain code consistency.

...t/shenyu-client-mcp/src/main/java/org/apache/shenyu/client/mcp/common/annotation/Header.java

...u-client-mcp/src/main/java/org/apache/shenyu/client/mcp/common/annotation/OpenApiConfig.java

…into mcp-auto-register

Copilot

Pull Request Overview

Copilot reviewed 35 out of 36 changed files in this pull request and generated 3 comments.

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-09-18T04:10:47Z

...client-mcp/src/main/java/org/apache/shenyu/client/mcp/common/constants/OpenApiConstants.java

+    /**
+     * the required of parameter key.
+     */
+    public static final String OPEN_API_PATH_PATH_METHOD_PARAMETERS_REQUIRED_KEY = "description";


The constant value should be 'required' instead of 'description' as this represents the required field of a parameter, not its description.

Suggested change

public static final String OPEN_API_PATH_PATH_METHOD_PARAMETERS_REQUIRED_KEY = "description";

public static final String OPEN_API_PATH_PATH_METHOD_PARAMETERS_REQUIRED_KEY = "required";

Copilot · 2025-09-18T04:10:48Z

.../main/java/org/apache/shenyu/springboot/starter/client/mcp/ShenyuMcpClientConfiguration.java

+     *
+     * @param clientConfig the client config
+     * @param shenyuClientRegisterRepository the shenyu client register repository
+     * @return the apache dubbo service bean listener


The return type documentation incorrectly mentions 'apache dubbo service bean listener' but should reference 'MCP service event listener' since this is for MCP, not Dubbo.

Suggested change

* @return the apache dubbo service bean listener

* @return the MCP service event listener

Copilot · 2025-09-18T04:10:48Z

...nt/shenyu-client-mcp/src/main/java/org/apache/shenyu/client/mcp/McpServiceEventListener.java

+            return superUrl;
+        }
+        return "";


The logic is inverted. When superUrl is blank, it returns the blank value, but when it's not blank, it returns an empty string. This should return superUrl when it's not blank and empty string when it is blank.

Suggested change

return superUrl;

}

return "";

return "";

}

return superUrl;

Aias00 · 2025-09-18T04:49:42Z

...client-mcp/src/main/java/org/apache/shenyu/client/mcp/common/constants/OpenApiConstants.java

+    /**
+     * the summary of method key.
+     */
+    public static final String OPEN_API_PATH_PATH_METHOD_SUMMARY_KEY = "summary";


double PATH

Aias00 · 2025-09-18T04:49:53Z

...client-mcp/src/main/java/org/apache/shenyu/client/mcp/common/constants/OpenApiConstants.java

+    /**
+     * the description of method key.
+     */
+    public static final String OPEN_API_PATH_PATH_METHOD_DESCRIPTION_KEY = "description";


double PATH, is that right?

Aias00 · 2025-09-18T04:49:58Z

...client-mcp/src/main/java/org/apache/shenyu/client/mcp/common/constants/OpenApiConstants.java

+    /**
+     * the operationId of method key.
+     */
+    public static final String OPEN_API_PATH_PATH_METHOD_OPERATION_ID_KEY = "operationId";


double PATH

Aias00 · 2025-09-18T04:50:05Z

...client-mcp/src/main/java/org/apache/shenyu/client/mcp/common/constants/OpenApiConstants.java

+    /**
+     * the tag of method key.
+     */
+    public static final String OPEN_API_PATH_PATH_METHOD_TAG_KEY = "tag";


double PATH

Aias00 · 2025-09-18T04:57:22Z

...nyu-client-mcp/src/main/java/org/apache/shenyu/client/mcp/generator/McpOpenApiGenerator.java

+/**
+ * the openApi generator.
+ */
+public class McpOpenApiGenerator {


this class should be put in a single module. such as mcp common or mcp core. cause this class may be general

Aias00 · 2025-09-18T04:57:55Z

...ient-mcp/src/main/java/org/apache/shenyu/client/mcp/generator/McpRequestConfigGenerator.java

+/**
+ * the mcpRequestConfig generator.
+ */
+public class McpRequestConfigGenerator {


this class should be put in a single module. such as mcp common or mcp core. cause this class may be general

Aias00 · 2025-09-18T04:59:35Z

shenyu-common/src/main/java/org/apache/shenyu/common/constant/Constants.java

+    /**
+     * When register by http, the mcpTools path.
+     */
+    String MCP_TOOLS_PATH = "/shenyu-client/register-mcpTools";


just "/shenyu-client/register-mcp" is fine

Aias00 · 2025-09-18T05:01:26Z

...examples/shenyu-examples-mcp/src/main/java/org/apache/shenyu/controller/OrderController.java

+     * @return the order dto
+     */
+    @GetMapping("/findById")
+    @ShenyuMcpClient(


ShenyuMcpClient is confusing, i think it is better to be called such as: ShenyuMcpTool.

Aias00 · 2025-09-18T05:07:05Z

hi, u can take a look at this link: https://docs.spring.io/spring-ai/reference/1.1-SNAPSHOT/api/mcp/mcp-annotations-overview.html
may be helpful

Aias00 · 2025-09-22T11:32:34Z

shenyu-admin/src/main/resources/mappers/ShenyuMcpHeader.xml

why rename? maybe u want to copy from this file? but made a mistake?

Aias00 · 2025-09-22T11:34:16Z

...ommon/src/main/java/org/apache/shenyu/client/mcp/generator/McpToolsRegisterDTOGenerator.java

+        JsonObject method = path.getAsJsonObject(operation.method());
+        JsonArray parameters = method.getAsJsonArray(OpenApiConstants.OPEN_API_PATH_OPERATION_METHOD_PARAMETERS_KEY);
+
+        root.addProperty("name", classMcpClient.toolName());


use constants

Aias00 · 2025-09-22T11:34:42Z

...client-mcp-common/src/main/java/org/apache/shenyu/client/mcp/utils/OpenApiConvertorUtil.java

+
+        io.swagger.v3.oas.annotations.media.Schema schemaAnn = annotation.schema();
+        if (!schemaAnn.implementation().equals(Void.class)
+                || !"".equals(schemaAnn.type())


StringUtils.isBlank

Aias00 · 2025-09-22T11:35:16Z

shenyu-client/shenyu-client-mcp/shenyu-client-mcp-common/pom.xml

+
+        <dependency>
+            <groupId>org.springdoc</groupId>
+            <artifactId>springdoc-openapi-starter-common</artifactId>


add License for this dep

…into mcp-auto-register

fea: shenyu mcp plugin auto register

5eec47c

fix

0f43089

478320 changed the title ~~Shenyu mcp plugin auto register~~ [feat]: shenyu mcp plugin auto register Sep 16, 2025

478320 and others added 4 commits September 17, 2025 00:03

add: validate method

ef8f339

fix

1bd5b66

Merge branch 'master' into mcp-auto-register

cd6a7af

Merge branch 'master' into mcp-auto-register

12a3984

Aias00 requested a review from Copilot September 17, 2025 07:44

Copilot AI reviewed Sep 17, 2025

View reviewed changes

Aias00 requested changes Sep 17, 2025

View reviewed changes

...t/shenyu-client-mcp/src/main/java/org/apache/shenyu/client/mcp/common/annotation/Header.java Outdated Show resolved Hide resolved

...u-client-mcp/src/main/java/org/apache/shenyu/client/mcp/common/annotation/OpenApiConfig.java Outdated Show resolved Hide resolved

478320 added 4 commits September 17, 2025 17:17

fix some bug

e9d6d93

Merge branch 'mcp-auto-register' of https://github.com/478320/shenyu …

eb6be2a

…into mcp-auto-register

fix

c1b8f05

import spring-doc common and delete useless annotation

485522b

Aias00 requested a review from Copilot September 18, 2025 04:10

Copilot AI reviewed Sep 18, 2025

View reviewed changes

fix

7115131

Aias00 requested changes Sep 18, 2025

View reviewed changes

478320 and others added 7 commits September 18, 2025 19:23

add annotation shenyuMcpToolParam

f3a7395

fix

6165a4b

Merge branch 'master' into mcp-auto-register

456d92c

Merge branch 'master' into mcp-auto-register

7460c1c

Merge branch 'master' into mcp-auto-register

09e8632

Merge branch 'master' into mcp-auto-register

c91d8a9

Merge branch 'master' into mcp-auto-register

0ac1913

Aias00 requested changes Sep 22, 2025

View reviewed changes

478320 added 2 commits September 22, 2025 23:09

fix

d65c2bf

Merge branch 'mcp-auto-register' of https://github.com/478320/shenyu …

4d21f07

…into mcp-auto-register

fix

e5bd9d8

Aias00 previously approved these changes Sep 22, 2025

View reviewed changes

Merge branch 'master' into mcp-auto-register

0bc285c

478320 dismissed Aias00’s stale review via 0bc285c September 22, 2025 15:42

fix

0910814

Aias00 approved these changes Sep 22, 2025

View reviewed changes

Aias00 merged commit 4cc679e into apache:master Sep 22, 2025
43 checks passed

Aias00 modified the milestones: 2.7.1, 2.7.0.3 Sep 23, 2025

	public static final String OPEN_API_PATH_PATH_METHOD_PARAMETERS_REQUIRED_KEY = "description";
	public static final String OPEN_API_PATH_PATH_METHOD_PARAMETERS_REQUIRED_KEY = "required";

	* @return the apache dubbo service bean listener
	* @return the MCP service event listener

Conversation

478320 commented Sep 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

478320 commented Sep 16, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Copilot AI Sep 17, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Sep 17, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

Copilot AI Sep 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 18, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 18, 2025

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Aias00 commented Sep 18, 2025

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

478320 commented Sep 16, 2025 •

edited

Loading