Simple MCP Fileserver

🚀 Simple MCP File Server

Simple MCP FileServer is a lightweight file service implementation based on the MCP protocol. It enables basic operations on files and directories over the network, including reading, writing, and listing directory contents.

🚀 Quick Start

Installation Steps

1. Download the source code:

   git clone https://github.com/yourusername/simple-mcp-fileserver.git
   

2. Install dependencies:

   npm install
   

3. Start the service:

   node index.js
   

Configuration Options

• Listening Address: Specify the IP address to which the server binds, default is 0.0.0.0.
• Listening Port: Specify the TCP port on which the server listens, default is 8090.
• Allowed Directories: Configure a list of accessible directories.
• Authentication Method: Supports multiple authentication mechanisms, such as token-based or username/password.

Basic Usage

1. Start the service:

   node index.js --port 8090 --address 0.0.0.0
   

2. Send requests:
   • File Reading:

     curl http://localhost:8090/file/read/path/to/file.txt
     

   • File Writing:

     curl -X POST -d "content=your content" http://localhost:8090/file/write/path/to/file.txt
     

   • Directory Listing:

     curl http://localhost:8090/dir/list/path/to/directory
     

✨ Features

Core Features

• File Reading: Read file content from a specified path.
• File Writing: Write content to a specified path.
• Directory Traversal: List all files and subdirectories in a specified directory.
• Health Check: Provide a simple health check endpoint.

Scalability

• Support for a custom plugin system.
• Extensible protocol support.

📦 Installation

Installation Steps

1. Download the source code:

   git clone https://github.com/yourusername/simple-mcp-fileserver.git
   

2. Install dependencies:

   npm install
   

3. Start the service:

   node index.js
   

💻 Usage Examples

Basic Usage

# Start the service
node index.js --port 8090 --address 0.0.0.0

# File Reading
curl http://localhost:8090/file/read/path/to/file.txt

# File Writing
curl -X POST -d "content=your content" http://localhost:8090/file/write/path/to/file.txt

# Directory Listing
curl http://localhost:8090/dir/list/path/to/directory

📚 Documentation

Introduction to the MCP Protocol

MCP (Multi-Channel Protocol) is a protocol for network data transmission that supports multiple channels and data formats. The features of the MCP protocol include:

1. Support for multi-channel communication.
2. Efficient data serialization.
3. An easily extensible plugin system.

Working Principle

Core Components

1. File Service
   • Provide basic file operations, such as reading, writing, and deleting.
   • Support directory traversal.
2. Network Communication
   • Use the TCP/IP protocol for data transmission.
   • Support multi-threaded request processing.
3. Security
   • Control access based on permissions.
   • Provide SSL/TLS encryption options.

API Reference

Core Interfaces

1. GET /file/read/{path}
   • Read the content of a file from the specified path.
   • Return result: The file content as a string.
2. POST /file/write/{path}
   • Write content to the specified path.
   • Request body: {content: string}
   • Return result: ok
3. GET /dir/list/{path}
   • List all files and subdirectories in the specified directory.
   • Return result: An array of file and directory names.

Extended Interfaces

• Support for extending more functions through the plugin system, such as compression and encryption.

Health Check

The server provides a simple health check endpoint:

curl http://localhost:8090/health
# Returns: ok

Troubleshooting

Common Issues

1. Initialization Failure:
   • Ensure that the service is running.
   • Check if the target port is occupied.
   • Verify that the /health endpoint returns ok.
2. Port Conflict:
   • Use the command lsof -i :<port> to check port usage.
   • Start the service on a different port.
3. Permission Issues:
   • Ensure that the server has permission to access the requested file path.

Security Considerations

This server provides direct access to the file system. Consider the following security measures:

• Run the server on a trusted network.
• Limit the scope of accessible directories.
• Consider implementing authentication in a production environment.
• Monitor server logs for suspicious activities.

Potential Improvement Directions

The MCP server can be extended with the following features:

1. Authentication and Authorization: Add user authentication and path-based permission control.
2. File Monitoring: Implement a notification mechanism for file changes.
3. Data Compression: Support compression formats such as gzip.
4. Encrypted Transmission: Enable SSL/TLS encryption by default.

🔧 Technical Details

Core Components

1. File Service
   • Provide basic file operations, such as reading, writing, and deleting.
   • Support directory traversal.
2. Network Communication
   • Use the TCP/IP protocol for data transmission.
   • Support multi-threaded request processing.
3. Security
   • Control access based on permissions.
   • Provide SSL/TLS encryption options.

MCP Protocol Features

1. Support for multi-channel communication.
2. Efficient data serialization.
3. An easily extensible plugin system.

📄 License

Copyright (c) 2023, Your Name.

🔗 Project Address

• GitHub

👥 Contributors

Thanks to the following people for their contributions to the project:

• [Your Name]
• [Contributor Name]