MCP File Navigator

🚀 MCP File Server

MCP File Server is a modular file management tool based on Node.js, supporting a variety of file operation functions. By configuring different services, you can extend its capabilities to meet custom requirements such as compression, encryption, etc.

🚀 Quick Start

📦 Installation

Install the required dependencies:

npm install express fs-extra shelljs

Start the Server

Start the server using the following command:

node mcp_server.js

The default port is 3000. To change the port, specify it when starting the server:

PORT=8080 node mcp_server.js

✨ Features

Set the Base Directory

Parameters:

• path: The path of the new base directory (must be an absolute path)

Return:

• Confirmation message

Get the Current Base Directory

Parameters:

• None

Return:

• The path of the current base directory

List Files

Parameters:

• directory (optional): The path of the directory to list (default is the root directory)

Return:

• A formatted list of files and directories

Read File Content

Parameters:

• path: The path of the file to read

Return:

• File content

Write to a File

Parameters:

• path: The path of the file to write to
• content: The content to write

Return:

• Confirmation message

Delete a File or Directory

Parameters:

• path: The path of the file or directory to delete

Return:

• Confirmation message

Execute Git Commands

Execute Git commands in the base directory.

Parameters:

• command: The Git command to execute (without the git prefix)
• shell (optional): The shell to use for command execution (cmd, powershell, bash)

Return:

• Command output (standard output and error output)

🔧 Technical Details

Logging and Debugging

Check the log file located at log/mcp_debug.log for detailed information about server operations and possible errors.

Troubleshooting

Common issues:

1. Path access error: Ensure that the BASE_DIRECTORY is set to a location accessible by the process.
2. Connection refused: Confirm that the server is running.
3. Tool not found: Verify that the tool names in the configuration file exactly match those defined on the server.
4. Port conflict: When running multiple MCP services, ensure that different ports are used.
5. Invalid base directory: When setting the base directory from chat, provide an absolute path (not a relative path).
6. Git command error: Ensure that Git is installed and the base directory is a valid Git repository.

🤝 Contribution Guidelines

How to Contribute

• Submit issue reports: Submit detailed error reports with steps to reproduce.
• Feature requests: Propose new features or improvements.
• Documentation improvement: Help improve or expand the existing documentation.
• Code contributions: Submit pull requests to fix bugs or implement new features.

Development Process

1. Create branches: Create separate branches for each feature or fix in your own repository.
2. Follow coding standards: Keep the code style consistent.
3. Write tests: Add corresponding test cases for new features or fixes.
4. Update documentation: Modify relevant documentation to reflect the changes made.
5. Submit pull requests: Submit a pull request that clearly describes the changes.

Pull Request Guidelines

• Each PR should focus on a single feature or fix.
• Include a detailed description and reason for the changes.
• Ensure that all tests pass.
• Use English as the primary language, unless otherwise specified.

📚 Documentation History

• Version 1.0: Initial release (October 2023)
• Version 1.1: Added Git command support and logging functionality (November 2023)

For further information or assistance, please refer to the project documentation or contact the maintenance team.