MCP Server Prototype

🚀 File System MCP Server

A Model Context Protocol (MCP) server that provides resources for accessing file metadata and content.

🚀 Quick Start

The File System MCP Server is a Model Context Protocol (MCP) server that offers resources for accessing file metadata and content. It enables clients to retrieve information about files and directories and read the content of files.

✨ Features

• Retrieve metadata (name, path, size, timestamp, permissions, etc.) of files and directories.
• Read the content of text and binary files.
• Automatically detect MIME types based on file extensions.
• Comprehensive logging.
• Utilize the Spring framework for dependency injection to enhance maintainability and testability.

📦 Resources

The server provides the following resources:

• file://metadata/{path} - Retrieve metadata of a file or directory.
• file://content/{path} - Retrieve the content of a file.

For more detailed information, please refer to the Resource Documentation.

🛠️ Tools

The server provides the following tools:

• list_files - List files in a directory.

For more information, please refer to the Tool Documentation.

🛠️ Build and Run

Prerequisites

• Java 17 or higher
• Maven
• Spring framework (automatically managed by Maven)

Build

mvn clean package

This will create an executable JAR file in the target directory.

Run

java -jar target/filesystem-mcp-1.0-SNAPSHOT-jar-with-dependencies.jar

📚 Documentation

• Resources
• Tools
• Prompts
• Spring Integration
• Spring Best Practices
• Migration from Dagger2 to Spring
• Dagger2 Best Practices (for reference)

🔧 Technical Details

Architecture

The server adopts a layered architecture:

1. Configuration Layer: Spring configuration classes for dependency injection.
2. Service Layer: Core services for handling file system operations.
3. Resource Layer: MCP resources for exposing file system functions.
4. Tool Layer: Utility classes for common operations.

Dependency Injection

The server uses the Spring framework for dependency injection, offering the following advantages:

• Use constructor injection to improve testability.
• Use @PostConstruct and @PreDestroy for lifecycle management.
• Use configuration classes for explicit Bean definition.
• Automatically discover components through component scanning.