dvirshasha1/mcp-filesystem-server

mcp-filesystem-server

A Model Context Protocol (MCP) server for filesystem operations.

Available Makefile Commands

• make init — Create a Python virtual environment and install all dependencies.
• make install — Install Python dependencies into the existing virtual environment.
• make run — Run the MCP server (ensure the virtual environment is activated).
• make test — Run all unit tests.

Available Tools (Handlers)

• open_file — Open and read the contents of a file. Expects { "path": "relative/path/to/file.txt" }.
• list_allowed_dir — List files and directories in the allowed root. Expects {}.
• read_file — Read a portion of a file. Expects { "path": "...", "offset": int, "length": int }.
• edit_file — Edit or replace part/all of a file. Expects { "path": "...", "content": "...", "offset": int (optional) }.
• make_dir — Create a new directory. Expects { "path": "relative/path/to/newdir" }.

Quick Start

1. Initialize the environment:

   make init
   

2. Run the server:

   make run
   

3. Run tests:

   make test
   

Requirements

• Python 3.8+
• GNU Make

Project Structure

• src/mcp_server/ — Server implementation and handlers
• tests/ — Unit tests
• requirements.txt — Python dependencies
• Makefile — Automation commands