refactor(mcp-server-chat2mysql): Refactor project structure to support both native and declarative SDK examples

codeboyzhou · codeboyzhou · commit a1c0276b57af · 2025-04-18T17:58:08.000+08:00
diff --git a/agent/agent.py b/agent/agent.py
diff --git a/agent/fastagent.config.yaml.example b/agent/fastagent.config.yaml.example
diff --git a/agent/fastagent.secrets.yaml.example b/agent/fastagent.secrets.yaml.example
diff --git a/mcp-server-chat2mysql/README.md b/mcp-server-chat2mysql/README.md
diff --git a/mcp-server-chat2mysql/commons/pom.xml b/mcp-server-chat2mysql/commons/pom.xml
@@ -0,0 +1,24 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>com.github.codeboyzhou</groupId>
+        <artifactId>mcp-server-chat2mysql</artifactId>
+        <version>1.0.0-SNAPSHOT</version>
+    </parent>
+
+    <artifactId>commons</artifactId>
+    <packaging>jar</packaging>
+
+    <properties>
+        <java.version>17</java.version>
+        <maven.compiler.source>${java.version}</maven.compiler.source>
+        <maven.compiler.target>${java.version}</maven.compiler.target>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
+    </properties>
+
+</project>
diff --git a/mcp-server-chat2mysql/commons/src/main/java/com/github/mcp/server/chat2mysql/enums/PromptMessageEnding.java b/mcp-server-chat2mysql/commons/src/main/java/com/github/mcp/server/chat2mysql/enums/PromptMessageEnding.java
@@ -1,4 +1,4 @@
-package com.github.mcp.examples.server.chat2mysql.enums;
+package com.github.mcp.server.chat2mysql.enums;
 
 public enum PromptMessageEnding {
 
diff --git a/mcp-server-chat2mysql/commons/src/main/java/com/github/mcp/server/chat2mysql/util/ServerInfo.java b/mcp-server-chat2mysql/commons/src/main/java/com/github/mcp/server/chat2mysql/util/ServerInfo.java
@@ -0,0 +1,8 @@
+package com.github.mcp.server.chat2mysql.util;
+
+public interface ServerInfo {
+
+    String SERVER_NAME = "mcp-server-chat2mysql";
+
+    String SERVER_VERSION = "1.0.0";
+}
diff --git a/mcp-server-chat2mysql/commons/src/main/java/com/github/mcp/server/chat2mysql/util/SqlHelper.java b/mcp-server-chat2mysql/commons/src/main/java/com/github/mcp/server/chat2mysql/util/SqlHelper.java
@@ -1,4 +1,4 @@
-package com.github.mcp.examples.server.chat2mysql.util;
+package com.github.mcp.server.chat2mysql.util;
 
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
diff --git a/mcp-server-chat2mysql/declarative-sdk-example/pom.xml b/mcp-server-chat2mysql/declarative-sdk-example/pom.xml
@@ -6,11 +6,11 @@
 
     <parent>
         <groupId>com.github.codeboyzhou</groupId>
-        <artifactId>mcp-java-sdk-examples</artifactId>
+        <artifactId>mcp-server-chat2mysql</artifactId>
         <version>1.0.0-SNAPSHOT</version>
     </parent>
 
-    <artifactId>mcp-server-chat2mysql-native</artifactId>
+    <artifactId>declarative-sdk-example</artifactId>
     <packaging>jar</packaging>
 
     <properties>
@@ -19,17 +19,12 @@
         <maven.compiler.target>${java.version}</maven.compiler.target>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
-        <!--==================== maven plugin versions ====================-->
-        <maven-shade-plugin.version>3.6.0</maven-shade-plugin.version>
-        <!--==================== dependency versions ====================-->
-        <mysql-connector-java.version>8.0.33</mysql-connector-java.version>
     </properties>
 
     <dependencies>
         <dependency>
-            <groupId>mysql</groupId>
-            <artifactId>mysql-connector-java</artifactId>
-            <version>${mysql-connector-java.version}</version>
+            <groupId>com.github.codeboyzhou</groupId>
+            <artifactId>commons</artifactId>
         </dependency>
     </dependencies>
 
@@ -49,7 +44,7 @@
                         <configuration>
                             <transformers>
                                 <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
-                                    <mainClass>com.github.mcp.examples.server.chat2mysql.McpStdioServer</mainClass>
+                                    <mainClass>com.github.mcp.server.chat2mysql.McpStdioServer</mainClass>
                                 </transformer>
                             </transformers>
                         </configuration>
diff --git a/mcp-server-chat2mysql/declarative-sdk-example/src/main/java/com/github/mcp/server/chat2mysql/McpStdioServer.java b/mcp-server-chat2mysql/declarative-sdk-example/src/main/java/com/github/mcp/server/chat2mysql/McpStdioServer.java
@@ -0,0 +1,18 @@
+package com.github.mcp.server.chat2mysql;
+
+import com.github.codeboyzhou.mcp.declarative.McpServers;
+import com.github.codeboyzhou.mcp.declarative.annotation.McpComponentScan;
+import com.github.codeboyzhou.mcp.declarative.server.McpServerInfo;
+
+import static com.github.mcp.server.chat2mysql.util.ServerInfo.SERVER_NAME;
+import static com.github.mcp.server.chat2mysql.util.ServerInfo.SERVER_VERSION;
+
+@McpComponentScan(basePackageClass = McpStdioServer.class)
+public class McpStdioServer {
+
+    public static void main(String[] args) {
+        McpServers servers = McpServers.run(McpStdioServer.class, args);
+        servers.startSyncStdioServer(McpServerInfo.builder().name(SERVER_NAME).version(SERVER_VERSION).build());
+    }
+
+}
diff --git a/mcp-server-chat2mysql/declarative-sdk-example/src/main/java/com/github/mcp/server/chat2mysql/MyMcpPrompts.java b/mcp-server-chat2mysql/declarative-sdk-example/src/main/java/com/github/mcp/server/chat2mysql/MyMcpPrompts.java
@@ -0,0 +1,50 @@
+package com.github.mcp.server.chat2mysql;
+
+import com.github.codeboyzhou.mcp.declarative.annotation.McpPrompt;
+import com.github.codeboyzhou.mcp.declarative.annotation.McpPromptParam;
+import com.github.codeboyzhou.mcp.declarative.annotation.McpPrompts;
+import com.github.mcp.server.chat2mysql.enums.PromptMessageEnding;
+import com.github.mcp.server.chat2mysql.util.SqlHelper;
+
+import java.util.Set;
+
+/**
+ * A class that defines MCP prompts to the MCP server.
+ *
+ * @author codeboyzhou
+ */
+@McpPrompts
+public class MyMcpPrompts {
+
+    /**
+     * Create a MCP prompt to generate SQL optimization tips.
+     *
+     * @param sql The SQL query to optimize.
+     * @return The prompt message, please see the README.md of this project for more details.
+     */
+    @McpPrompt(name = "generate_sql_optimization_tips", description = "Generate SQL optimization tips.")
+    public static String generateSqlOptimizationTips(
+        @McpPromptParam(name = "sql", description = "The SQL query to optimize.", required = true) String sql
+    ) {
+        StringBuilder promptTemplate = new StringBuilder("""
+            There is an SQL statement along with its EXPLAIN plan and table schemas.
+            Please analyze the query performance and provide optimization recommendations.""")
+            .append("\n\n")
+            .append("The SQL statement is: ").append(sql)
+            .append("\n\n");
+
+        Set<String> tableNames = SqlHelper.parseTableNames(sql);
+        for (String tableName : tableNames) {
+            final String tableSchema = SqlHelper.showCreateTable(tableName);
+            promptTemplate.append("The table schema for ").append(tableName).append(" is: ").append(tableSchema)
+                .append("\n\n");
+        }
+
+        promptTemplate.append("The EXPLAIN plan for the SQL statement is: ").append(SqlHelper.explainSql(sql));
+        promptTemplate.append("\n\nPlease provide optimization recommendations for the SQL statement.");
+        promptTemplate.append("\n\n").append(PromptMessageEnding.ofCurrentUserLanguage());
+
+        return promptTemplate.toString();
+    }
+
+}
diff --git a/mcp-server-chat2mysql/native-sdk-example/pom.xml b/mcp-server-chat2mysql/native-sdk-example/pom.xml
@@ -0,0 +1,57 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>com.github.codeboyzhou</groupId>
+        <artifactId>mcp-server-chat2mysql</artifactId>
+        <version>1.0.0-SNAPSHOT</version>
+    </parent>
+
+    <artifactId>native-sdk-example</artifactId>
+    <packaging>jar</packaging>
+
+    <properties>
+        <java.version>17</java.version>
+        <maven.compiler.source>${java.version}</maven.compiler.source>
+        <maven.compiler.target>${java.version}</maven.compiler.target>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
+    </properties>
+
+    <dependencies>
+        <dependency>
+            <groupId>com.github.codeboyzhou</groupId>
+            <artifactId>commons</artifactId>
+        </dependency>
+    </dependencies>
+
+    <build>
+        <finalName>mcp-server-chat2mysql</finalName>
+        <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-shade-plugin</artifactId>
+                <version>${maven-shade-plugin.version}</version>
+                <executions>
+                    <execution>
+                        <goals>
+                            <goal>shade</goal>
+                        </goals>
+                        <phase>package</phase>
+                        <configuration>
+                            <transformers>
+                                <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">
+                                    <mainClass>com.github.mcp.server.chat2mysql.McpStdioServer</mainClass>
+                                </transformer>
+                            </transformers>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
+        </plugins>
+    </build>
+
+</project>
diff --git a/mcp-server-chat2mysql/native-sdk-example/src/main/java/com/github/mcp/server/chat2mysql/McpPrompts.java b/mcp-server-chat2mysql/native-sdk-example/src/main/java/com/github/mcp/server/chat2mysql/McpPrompts.java
@@ -1,7 +1,7 @@
-package com.github.mcp.examples.server.chat2mysql;
+package com.github.mcp.server.chat2mysql;
 
-import com.github.mcp.examples.server.chat2mysql.enums.PromptMessageEnding;
-import com.github.mcp.examples.server.chat2mysql.util.SqlHelper;
+import com.github.mcp.server.chat2mysql.enums.PromptMessageEnding;
+import com.github.mcp.server.chat2mysql.util.SqlHelper;
 import io.modelcontextprotocol.server.McpServerFeatures;
 import io.modelcontextprotocol.server.McpSyncServer;
 import io.modelcontextprotocol.spec.McpSchema;
diff --git a/mcp-server-chat2mysql/native-sdk-example/src/main/java/com/github/mcp/server/chat2mysql/McpStdioServer.java b/mcp-server-chat2mysql/native-sdk-example/src/main/java/com/github/mcp/server/chat2mysql/McpStdioServer.java
@@ -1,25 +1,19 @@
-package com.github.mcp.examples.server.chat2mysql;
+package com.github.mcp.server.chat2mysql;
 
 import io.modelcontextprotocol.server.McpServer;
 import io.modelcontextprotocol.server.McpSyncServer;
 import io.modelcontextprotocol.server.transport.StdioServerTransportProvider;
 import io.modelcontextprotocol.spec.McpSchema;
 
+import static com.github.mcp.server.chat2mysql.util.ServerInfo.SERVER_NAME;
+import static com.github.mcp.server.chat2mysql.util.ServerInfo.SERVER_VERSION;
+
 /**
  * Java server implementing Model Context Protocol (MCP) for chat2mysql.
  *
  * @author codeboyzhou
  */
 public class McpStdioServer {
-    /**
-     * The name of the MCP server.
-     */
-    private static final String SERVER_NAME = "mcp-server-chat2mysql";
-
-    /**
-     * The version of the MCP server.
-     */
-    private static final String SERVER_VERSION = "0.1.0";
 
     /**
      * The MCP sync server instance.
diff --git a/mcp-server-chat2mysql/pom.xml b/mcp-server-chat2mysql/pom.xml
@@ -0,0 +1,52 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+
+    <modelVersion>4.0.0</modelVersion>
+
+    <parent>
+        <groupId>com.github.codeboyzhou</groupId>
+        <artifactId>mcp-java-sdk-examples</artifactId>
+        <version>1.0.0-SNAPSHOT</version>
+    </parent>
+
+    <artifactId>mcp-server-chat2mysql</artifactId>
+    <packaging>pom</packaging>
+
+    <modules>
+        <module>commons</module>
+        <module>declarative-sdk-example</module>
+        <module>native-sdk-example</module>
+    </modules>
+
+    <properties>
+        <java.version>17</java.version>
+        <maven.compiler.source>${java.version}</maven.compiler.source>
+        <maven.compiler.target>${java.version}</maven.compiler.target>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+        <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
+        <!--==================== maven plugin versions ====================-->
+        <maven-shade-plugin.version>3.6.0</maven-shade-plugin.version>
+        <!--==================== dependency versions ====================-->
+        <mysql-connector-j.version>9.2.0</mysql-connector-j.version>
+    </properties>
+
+    <dependencyManagement>
+        <dependencies>
+            <dependency>
+                <groupId>com.github.codeboyzhou</groupId>
+                <artifactId>commons</artifactId>
+                <version>${project.version}</version>
+            </dependency>
+        </dependencies>
+    </dependencyManagement>
+
+    <dependencies>
+        <dependency>
+            <groupId>com.mysql</groupId>
+            <artifactId>mysql-connector-j</artifactId>
+            <version>${mysql-connector-j.version}</version>
+        </dependency>
+    </dependencies>
+
+</project>
diff --git a/pom.xml b/pom.xml
@@ -10,7 +10,7 @@
     <packaging>pom</packaging>
 
     <modules>
-        <module>mcp-server-chat2mysql-native</module>
+        <module>mcp-server-chat2mysql</module>
         <module>mcp-server-filesystem-native</module>
     </modules>
 
@@ -23,37 +23,14 @@
         <!--==================== maven plugin versions ====================-->
         <sortpom-maven-plugin.version>4.0.0</sortpom-maven-plugin.version>
         <!--==================== dependency versions ======================-->
-        <mcp-sdk.version>0.9.0</mcp-sdk.version>
-        <jetty.version>12.0.18</jetty.version>
-        <logback.version>1.5.18</logback.version>
+        <mcp-declarative-java-sdk.version>0.3.0-SNAPSHOT</mcp-declarative-java-sdk.version>
     </properties>
 
-    <dependencyManagement>
-        <dependencies>
-            <dependency>
-                <groupId>io.modelcontextprotocol.sdk</groupId>
-                <artifactId>mcp-bom</artifactId>
-                <version>${mcp-sdk.version}</version>
-                <type>pom</type>
-                <scope>import</scope>
-            </dependency>
-        </dependencies>
-    </dependencyManagement>
-
     <dependencies>
         <dependency>
-            <groupId>ch.qos.logback</groupId>
-            <artifactId>logback-classic</artifactId>
-            <version>${logback.version}</version>
-        </dependency>
-        <dependency>
-            <groupId>io.modelcontextprotocol.sdk</groupId>
-            <artifactId>mcp</artifactId>
-        </dependency>
-        <dependency>
-            <groupId>org.eclipse.jetty.ee10</groupId>
-            <artifactId>jetty-ee10-servlet</artifactId>
-            <version>${jetty.version}</version>
+            <groupId>io.github.codeboyzhou</groupId>
+            <artifactId>mcp-declarative-java-sdk</artifactId>
+            <version>0.3.0-SNAPSHOT</version>
         </dependency>
     </dependencies>
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-package com.github.mcp.examples.server.chat2mysql.enums;`
	`1`	`+package com.github.mcp.server.chat2mysql.enums;`
`2`	`2`
`3`	`3`	`public enum PromptMessageEnding {`
`4`	`4`