Better MCP File Server

🚀 BetterMCPFileServer

BetterMCPFileServer is an optimized file server designed to offer an efficient, secure, and convenient file management experience. It supports mounting multiple directories via the command-line interface and performing file operations through simple APIs.

🚀 Quick Start

When starting BetterMCPFileServer, you need to specify at least one mapping relationship between an alias and a directory:

BetterMCPFileServer alias:directory [alias2:directory2 ...]

Example Usage

• Single directory:

  BetterMCPFileServer code:~/projects
  

• Multiple directories:

  BetterMCPFileServer code:~/Development docs:~/Documents/Technical notes:~/Notes
  

✨ Features

Core Features

• File Writing: Create or update files.
• Content Reading: Retrieve the content of specified files.
• File Editing: Modify specific parts of files.
• File Management: Perform operations such as moving, renaming, copying, or deleting files.
• Directory Management: Create, rename, or delete directories.
• Search Function: Find files and directories using pattern matching.

Pattern Matching Examples

• *: List top-level items (similar to a simple directory listing).
• projects/*.js: All .js files in the projects directory.
• **/*.md: Recursively find all Markdown files.

📦 Installation

Install via npm (Coming Soon)

npm install -g BetterMCPFileServer  # Not available yet

# Install from Source Code (Current Method)
git clone https://github.com/martinschlott/BetterMCPFileServer.git
cd BetterMCPFileServer
npm install
npm run build
npm link  # Optional, for global command usage

💻 Usage Examples

Operating on the Virtual Root Directory

// List all aliases
searchFilesAndFolders({ pattern: "*" })

// Example result:
[
  { name: 'code', type: 'directory' },
  { name: 'docs', type: 'directory' }
]

File Management Operations

writeFile({
  filePath: "projects/test.txt",
  content: "Hello, World!"
});

readFileContent({
  filePath: "projects/test.txt"
});

// Returns: "Hello, World!"

📚 Documentation

Advanced Configuration

You can create a simple shell script to maintain consistent configurations:

#!/bin/bash
# start-server.sh
BetterMCPFileServer \
  code:~/Development/MyProjects \
  docs:~/Documents/Technical \
  data:~/Data/Samples \
  config:~/Configuration

API Reference

BetterMCPFileServer provides 6 powerful API functions covering all file system operations:

1. writeFile

Create or update a file:

writeFile({
  filePath: "projects/README.md",
  content: "# My Project\n\nThis is a readme file."
})

2. readFileContent

Read the content of a file:

readFileContent({
  filePath: "projects/README.md"
})

3. editFile

Edit specific parts of a file:

editFile({
  filePath: "projects/README.md",
  edits: [
    {
      oldText: "# My Project",
      newText: "# Awesome Project"
    }
  ],
  dryRun: false
})

4. manageFile

Perform file operations (move, rename, copy, delete):

manageFile({
  action: "move",
  filePath: "projects/old.js",
  newFilePath: "projects/new.js"
})

5. manageFolder

Manage directories (create, rename, delete):

manageFolder({
  action: "create",
  folderPath: "projects/new-directory"
})

6. searchFilesAndFolders

Search for files and directories via pattern matching:

searchFilesAndFolders({
  pattern: "projects/**/*.ts",
  includeMetadata: false
})

⚠️ Important Note

• Alias Consideration: Ensure that aliases are unique in the system to avoid conflicts.
• Permission Issues: The server requires sufficient permissions to access the specified directories.
• Performance Optimization: For large files or frequent operations, it is recommended to use reasonable pagination and filtering mechanisms.

👥 Project Team

• Development Team: Martin Schlott and his development team.
• Contributors: Thanks to all open-source community members who have contributed to this project.

📄 License

BetterMCPFileServer is licensed under the MIT License, allowing free use, modification, and distribution.

📞 Contact

For feedback or technical support, please contact:

• Email: support@bettermcpfileserver.com
• GitHub Repository: https://github.com/martinschlott/BetterMCPFileServer