refactor(mcp-server-filesystem): Simplify file operation tools and prompts, update README for clarity and consistency

Author: codeboyzhou

mcp-server-filesystem/README.adoc

@@ -20,31 +20,16 @@ Java server implementing Model Context Protocol (MCP) for filesystem operations.
 - *read_file*
   * Read complete file contents with UTF-8 encoding.
   * Input:
-    ** `path` (string): The path to the file to read.
+    ** `path` (string): The filepath to read, required.
   * Output: Complete file contents with UTF-8 encoding.
 
 - *list_files*
-  * List files of a directory with name-based filtering and recursion option.
+  * List files of a directory.
   * Input:
-    ** `directoryPath` (string): The path to the directory to read.
-    ** `fileNamePattern` (string): Regular expression to filter files, if it's empty, all files will be listed. Default is empty.
-    ** `recursive` (boolean): Whether to list files recursively. Default is `false`.
-  * Output: A list of file names (paths if 'recursive' is `true`), or empty string if no files are found.
-
-=== Prompts
-
-- *read_file*
-  * For `read_file` tool
-  * Input: `filepath` (string)
-  * Output: What is the content of this file: `<filepath>`.
-
-- *list_files*
-  * For `list_files` tool
-  * Input: `directoryPath` (string), `fileNamePattern` (string), `recursive` (boolean)
-  * Output:
-    ** Please list files in this directory: `<directoryPath>`.
-    ** Please list files in this directory: `<directoryPath>`, with file name pattern: `<fileNamePattern>`.
-    ** Please list files in this directory: `<directoryPath>`, with file name pattern: `<fileNamePattern>`, recursively.
+    ** `path` (string): The directory path to read, required.
+    ** `pattern` (string): Regular expression to filter files, optional, default is empty, means no filter.
+    ** `recursive` (boolean): Whether to list files recursively, optional, default is `false`.
+  * Output: A list of file names (paths if 'recursive' is `true`), or empty string if no files found.
 
 == Usage with MCP Client
 

mcp-server-filesystem/src/main/java/com/github/mcp/examples/server/filesystem/McpPrompts.java

@@ -14,30 +14,25 @@
 public final class McpResources {
 
     /**
-     * Create a new resource to the MCP server that provides access to the file system.
+     * Create a MCP resource that provides access to the file system.
      * Note that this resource is just an example of how to add a resource to the MCP server.
      * So it's not really useful for anything other than demonstration purposes.
      *
-     * @return A specification for the MCP resource.
+     * @return {@link McpServerFeatures.SyncResourceSpecification}
      */
-    public static McpServerFeatures.SyncResourceSpecification fileSystemResource() {
+    public static McpServerFeatures.SyncResourceSpecification filesystem() {
+        // Step 1: Create a resource with URI, name, description, and MIME type.
         McpSchema.Resource resource = new McpSchema.Resource(
-            "file://system",
-            "filesystem",
-            "File system operations interface",
-            "text/plain",
+            "file://system", "filesystem", "File system operations interface", "text/plain",
             new McpSchema.Annotations(List.of(McpSchema.Role.ASSISTANT, McpSchema.Role.USER), 1.0)
         );
-
-        return new McpServerFeatures.SyncResourceSpecification(
-            resource,
-            (exchange, request) -> {
-                McpSchema.ResourceContents contents = new McpSchema.TextResourceContents(
-                    resource.uri(), resource.mimeType(), "No specific resource contents, just use the tools."
-                );
-                return new McpSchema.ReadResourceResult(List.of(contents));
-            }
-        );
+        // Step 2: Create a handler that returns the contents of the resource.
+        return new McpServerFeatures.SyncResourceSpecification(resource, (exchange, request) -> {
+            McpSchema.ResourceContents contents = new McpSchema.TextResourceContents(
+                resource.uri(), resource.mimeType(), "No specific resource contents, just use the tools."
+            );
+            return new McpSchema.ReadResourceResult(List.of(contents));
+        });
     }
 
     /**
@@ -46,7 +41,7 @@ public static McpServerFeatures.SyncResourceSpecification fileSystemResource() {
      * @param server The MCP server to add resources to.
      */
     public static void addAllTo(McpSyncServer server) {
-        server.addResource(fileSystemResource());
+        server.addResource(filesystem());
     }
 
 }

mcp-server-filesystem/src/main/java/com/github/mcp/examples/server/filesystem/McpResources.java

@@ -70,9 +70,8 @@ private void initialize() {
             .capabilities(serverCapabilities)
             .build();
 
-        // Add resources, prompts and tools to the MCP server
+        // Add resources and tools to the MCP server
         McpResources.addAllTo(server);
-        McpPrompts.addAllTo(server);
         McpTools.addAllTo(server);
 
         // Start the HTTP server

mcp-server-filesystem/src/main/java/com/github/mcp/examples/server/filesystem/McpSseServer.java

@@ -52,9 +52,8 @@ public static void main(String[] args) {
         // Initialize MCP server
         McpStdioServer mcpStdioServer = new McpStdioServer();
         mcpStdioServer.initialize();
-        // Add resources, prompts and tools to the MCP server
+        // Add resources and tools to the MCP server
         McpResources.addAllTo(mcpStdioServer.server);
-        McpPrompts.addAllTo(mcpStdioServer.server);
         McpTools.addAllTo(mcpStdioServer.server);
     }