polish(main): Some minor enhancements

codeboyzhou · codeboyzhou · commit c4d94637ecd8 · 2025-05-18T15:37:27.000+08:00
diff --git a/src/main/java/com/github/codeboyzhou/mcp/declarative/annotation/McpComponentScan.java b/src/main/java/com/github/codeboyzhou/mcp/declarative/annotation/McpComponentScan.java
@@ -1,5 +1,7 @@
 package com.github.codeboyzhou.mcp.declarative.annotation;
 
+import com.github.codeboyzhou.mcp.declarative.util.StringHelper;
+
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
@@ -8,7 +10,7 @@
 @Target(ElementType.TYPE)
 @Retention(RetentionPolicy.RUNTIME)
 public @interface McpComponentScan {
-    String basePackage() default "";
+    String basePackage() default StringHelper.EMPTY;
 
     Class<?> basePackageClass() default Object.class;
 }
diff --git a/src/main/java/com/github/codeboyzhou/mcp/declarative/annotation/McpPrompt.java b/src/main/java/com/github/codeboyzhou/mcp/declarative/annotation/McpPrompt.java
@@ -1,5 +1,7 @@
 package com.github.codeboyzhou.mcp.declarative.annotation;
 
+import com.github.codeboyzhou.mcp.declarative.util.StringHelper;
+
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
@@ -9,7 +11,7 @@
 @Retention(RetentionPolicy.RUNTIME)
 public @interface McpPrompt {
 
-    String name() default "";
+    String name() default StringHelper.EMPTY;
 
     String description();
 }
diff --git a/src/main/java/com/github/codeboyzhou/mcp/declarative/annotation/McpResource.java b/src/main/java/com/github/codeboyzhou/mcp/declarative/annotation/McpResource.java
@@ -1,5 +1,6 @@
 package com.github.codeboyzhou.mcp.declarative.annotation;
 
+import com.github.codeboyzhou.mcp.declarative.util.StringHelper;
 import io.modelcontextprotocol.spec.McpSchema;
 
 import java.lang.annotation.ElementType;
@@ -12,7 +13,7 @@
 public @interface McpResource {
     String uri();
 
-    String name() default "";
+    String name() default StringHelper.EMPTY;
 
     String description();
 
diff --git a/src/main/java/com/github/codeboyzhou/mcp/declarative/annotation/McpTool.java b/src/main/java/com/github/codeboyzhou/mcp/declarative/annotation/McpTool.java
@@ -1,5 +1,7 @@
 package com.github.codeboyzhou.mcp.declarative.annotation;
 
+import com.github.codeboyzhou.mcp.declarative.util.StringHelper;
+
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
@@ -9,7 +11,7 @@
 @Retention(RetentionPolicy.RUNTIME)
 public @interface McpTool {
 
-    String name() default "";
+    String name() default StringHelper.EMPTY;
 
     String description();
 }
diff --git a/src/main/java/com/github/codeboyzhou/mcp/declarative/configuration/McpServerConfiguration.java b/src/main/java/com/github/codeboyzhou/mcp/declarative/configuration/McpServerConfiguration.java
@@ -1,6 +1,7 @@
 package com.github.codeboyzhou.mcp.declarative.configuration;
 
 import com.fasterxml.jackson.annotation.JsonProperty;
+import com.github.codeboyzhou.mcp.declarative.util.StringHelper;
 
 import java.util.Map;
 
@@ -37,7 +38,7 @@ public static McpServerConfiguration defaultConfiguration() {
             Map.of(),
             "/mcp/message",
             "/sse",
-            "",
+            StringHelper.EMPTY,
             8080
         );
     }
diff --git a/src/main/java/com/github/codeboyzhou/mcp/declarative/server/McpServerInfo.java b/src/main/java/com/github/codeboyzhou/mcp/declarative/server/McpServerInfo.java
@@ -1,5 +1,7 @@
 package com.github.codeboyzhou.mcp.declarative.server;
 
+import com.github.codeboyzhou.mcp.declarative.util.StringHelper;
+
 import java.time.Duration;
 
 public class McpServerInfo {
@@ -46,7 +48,7 @@ public static class Builder<T extends Builder<T>> {
 
         protected String version = "1.0.0";
 
-        protected String instructions = "";
+        protected String instructions = StringHelper.EMPTY;
 
         protected Duration requestTimeout = Duration.ofSeconds(10);
 
diff --git a/src/test/java/com/github/codeboyzhou/mcp/declarative/McpServersTest.java b/src/test/java/com/github/codeboyzhou/mcp/declarative/McpServersTest.java
@@ -1,5 +1,7 @@
 package com.github.codeboyzhou.mcp.declarative;
 
+import com.github.codeboyzhou.mcp.declarative.annotation.McpPrompts;
+import com.github.codeboyzhou.mcp.declarative.annotation.McpResources;
 import com.github.codeboyzhou.mcp.declarative.annotation.McpTools;
 import com.github.codeboyzhou.mcp.declarative.exception.McpServerException;
 import com.github.codeboyzhou.mcp.declarative.server.McpServerInfo;
@@ -8,6 +10,8 @@
 import com.github.codeboyzhou.mcp.declarative.server.TestMcpComponentScanBasePackageString;
 import com.github.codeboyzhou.mcp.declarative.server.TestMcpComponentScanDefault;
 import com.github.codeboyzhou.mcp.declarative.server.TestMcpComponentScanIsNull;
+import com.github.codeboyzhou.mcp.declarative.server.TestMcpPrompts;
+import com.github.codeboyzhou.mcp.declarative.server.TestMcpResources;
 import com.github.codeboyzhou.mcp.declarative.server.TestMcpTools;
 import org.junit.jupiter.api.AfterEach;
 import org.junit.jupiter.api.BeforeEach;
@@ -42,10 +46,21 @@ void setUp() {
     void tearDown() throws NoSuchFieldException, IllegalAccessException {
         reflections = getReflectionsField();
         assertNotNull(reflections);
+
         Map<String, Set<String>> scannedClasses = reflections.getStore().get(Scanners.TypesAnnotated.name());
+
+        Set<String> scannedPromptClass = scannedClasses.get(McpPrompts.class.getName());
+        assertEquals(1, scannedPromptClass.size());
+        assertEquals(scannedPromptClass.iterator().next(), TestMcpPrompts.class.getName());
+
+        Set<String> scannedResourceClass = scannedClasses.get(McpResources.class.getName());
+        assertEquals(1, scannedResourceClass.size());
+        assertEquals(scannedResourceClass.iterator().next(), TestMcpResources.class.getName());
+
         Set<String> scannedToolClass = scannedClasses.get(McpTools.class.getName());
         assertEquals(1, scannedToolClass.size());
         assertEquals(scannedToolClass.iterator().next(), TestMcpTools.class.getName());
+
         reflections = null;
     }
 
@@ -81,10 +96,10 @@ void testStartSyncSseServer() {
             McpSseServerInfo serverInfo = McpSseServerInfo.builder()
                 .instructions("test-mcp-sync-sse-server-instructions")
                 .requestTimeout(Duration.ofSeconds(10))
-                .baseUrl("http://127.0.0.1:8080")
+                .baseUrl("http://127.0.0.1:8081")
                 .messageEndpoint("/message")
                 .sseEndpoint("/sse")
-                .port(8080)
+                .port(8081)
                 .name("test-mcp-sync-sse-server")
                 .version("1.0.0")
                 .build();
diff --git a/src/test/java/com/github/codeboyzhou/mcp/declarative/server/TestMcpPrompts.java b/src/test/java/com/github/codeboyzhou/mcp/declarative/server/TestMcpPrompts.java
@@ -7,20 +7,22 @@
 @McpPrompts
 public class TestMcpPrompts {
 
+    @SuppressWarnings("unused")
     @McpPrompt(name = "prompt1", description = "prompt1")
     public static String prompt1(
-        @McpPromptParam(name = "name", description = "name", required = true) String name,
-        @McpPromptParam(name = "version", description = "version", required = true) String version
+        @McpPromptParam(name = "argument1", description = "argument1", required = true) String argument1,
+        @McpPromptParam(name = "argument2", description = "argument2", required = true) String argument2
     ) {
-        return "Hello " + name + ", I am " + version;
+        return String.format("This is prompt1, required argument1: %s, required argument2: %s", argument1, argument2);
     }
 
+    @SuppressWarnings("unused")
     @McpPrompt(description = "prompt2")
     public static String prompt2(
-        @McpPromptParam(name = "name", description = "name") String name,
-        @McpPromptParam(name = "version", description = "version") String version
+        @McpPromptParam(name = "argument1", description = "argument1") String argument1,
+        @McpPromptParam(name = "argument2", description = "argument2") String argument2
     ) {
-        return "Hello " + name + ", I am " + version;
+        return String.format("This is prompt2, optional argument1: %s, optional argument2: %s", argument1, argument2);
     }
 
 }
diff --git a/src/test/java/com/github/codeboyzhou/mcp/declarative/server/TestMcpResources.java b/src/test/java/com/github/codeboyzhou/mcp/declarative/server/TestMcpResources.java
@@ -6,14 +6,16 @@
 @McpResources
 public class TestMcpResources {
 
+    @SuppressWarnings("unused")
     @McpResource(uri = "test://resource1", name = "resource1", description = "resource1")
     public String resource1() {
-        return System.lineSeparator();
+        return "This is resource1 content";
     }
 
+    @SuppressWarnings("unused")
     @McpResource(uri = "test://resource2", description = "resource2")
     public String resource2() {
-        return System.lineSeparator();
+        return "This is resource2 content";
     }
 
 }
diff --git a/src/test/java/com/github/codeboyzhou/mcp/declarative/server/TestMcpTools.java b/src/test/java/com/github/codeboyzhou/mcp/declarative/server/TestMcpTools.java
@@ -10,19 +10,19 @@ public class TestMcpTools {
     @SuppressWarnings("unused")
     @McpTool(name = "tool1", description = "tool1")
     public static String tool1(
-        @McpToolParam(name = "name", description = "name", required = true) String name,
-        @McpToolParam(name = "version", description = "version", required = true) String version
+        @McpToolParam(name = "argument1", description = "argument1", required = true) String argument1,
+        @McpToolParam(name = "argument2", description = "argument2", required = true) String argument2
     ) {
-        return "Hello " + name + ", I am " + version;
+        return String.format("This is tool1, required argument1: %s, required argument2: %s", argument1, argument2);
     }
 
     @SuppressWarnings("unused")
     @McpTool(description = "tool2")
     public static String tool2(
-        @McpToolParam(name = "name", description = "name") String name,
-        @McpToolParam(name = "version", description = "version") String version
+        @McpToolParam(name = "argument1", description = "argument1") String argument1,
+        @McpToolParam(name = "argument2", description = "argument2") String argument2
     ) {
-        return "Hello " + name + ", I am " + version;
+        return String.format("This is tool2, optional argument1: %s, optional argument2: %s", argument1, argument2);
     }
 
     @SuppressWarnings("unused")
@@ -31,7 +31,8 @@ public static String tool3(
         @McpToolParam(name = "complexJsonSchema", description = "complexJsonSchema")
         TestMcpToolComplexJsonSchema complexJsonSchema
     ) {
-        return String.format("Hello, my name is %s, I am from %s", complexJsonSchema.name(), complexJsonSchema.country());
+        return String.format("This is tool3 for testing complex json schema: my name is %s, I am from %s",
+            complexJsonSchema.name(), complexJsonSchema.country());
     }
 
 }

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`package com.github.codeboyzhou.mcp.declarative.configuration;`
`2`	`2`
`3`	`3`	`import com.fasterxml.jackson.annotation.JsonProperty;`
	`4`	`+import com.github.codeboyzhou.mcp.declarative.util.StringHelper;`
`4`	`5`
`5`	`6`	`import java.util.Map;`
`6`	`7`
`@@ -37,7 +38,7 @@ public static McpServerConfiguration defaultConfiguration() {`
`37`	`38`	`Map.of(),`
`38`	`39`	`"/mcp/message",`
`39`	`40`	`"/sse",`
`40`		`- "",`
	`41`	`+ StringHelper.EMPTY,`
`41`	`42`	`8080`
`42`	`43`	`);`
`43`	`44`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,14 +6,16 @@`
`6`	`6`	`@McpResources`
`7`	`7`	`public class TestMcpResources {`
`8`	`8`
	`9`	`+ @SuppressWarnings("unused")`
`9`	`10`	`@McpResource(uri = "test://resource1", name = "resource1", description = "resource1")`
`10`	`11`	`public String resource1() {`
`11`		`- return System.lineSeparator();`
	`12`	`+ return "This is resource1 content";`
`12`	`13`	`}`
`13`	`14`
	`15`	`+ @SuppressWarnings("unused")`
`14`	`16`	`@McpResource(uri = "test://resource2", description = "resource2")`
`15`	`17`	`public String resource2() {`
`16`		`- return System.lineSeparator();`
	`18`	`+ return "This is resource2 content";`
`17`	`19`	`}`
`18`	`20`
`19`	`21`	`}`