MCP Local File Server

🚀 MCP Local File Server

A server that allows you to access and manipulate local files using the MCP (Management Control Panel).

🚀 Quick Start

This section guides you through the steps to set up and start the MCP Local File Server.

📦 Installation

1. Clone the repository:

git clone https://github.com/fmorus/mcp-local-file-server.git
cd mcp-local-file-server

2. Install the dependencies:

npm install

3. Start the server:

npm start

The server will run at http://localhost:3000.

📚 Documentation

API Endpoints

List Files

• GET /files?dir={directory}
• Lists all files in the specified directory.
• The dir parameter is optional (default: current directory).

Read File

• GET /file?path={file_path}
• Reads the content of a file.

Upload File

• POST /file
• Uploads a file.
• Use the multipart/form-data format with the field name file.

Update File

• PUT /file
• Updates the content of a file.
• Request body: { "path": "file_path", "content": "new_content" }

Delete File

• DELETE /file?path={file_path}
• Deletes a file or directory.

💻 Usage Examples

Basic Usage

// List files
fetch('http://localhost:3000/files')
  .then(response => response.json())
  .then(files => console.log(files));

// Read file
fetch('http://localhost:3000/file?path=/caminho/do/arquivo.txt')
  .then(response => response.json())
  .then(data => console.log(data.content));

// Upload file
const formData = new FormData();
formData.append('file', arquivoParaUpload);
fetch('http://localhost:3000/file', {
  method: 'POST',
  body: formData
});

// Update file
fetch('http://localhost:3000/file', {
  method: 'PUT',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    path: '/caminho/do/arquivo.txt',
    content: 'Novo conteúdo'
  })
});

// Delete file
fetch('http://localhost:3000/file?path=/caminho/do/arquivo.txt', {
  method: 'DELETE'
});

⚠️ Important Note

This server has full access to system files. Please use it only in a secure and trusted environment.