Skip to content

A local Python-based MCP server enabling Claude Desktop to interact with your filesystem using natural language commands. Includes CRUD file operations, security layer, and full Claude integration.

Notifications You must be signed in to change notification settings

CodingWithMK/filesystem_mcp_server

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

6 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🗂️ Python MCP Filesystem Server

This project is a Python-based MCP (Model Context Protocol) server that allows Claude Desktop to perform secure and controlled local filesystem operations via natural language commands. It bridges the gap between conversational AI and direct file management by implementing the MCP 1.0 protocol with full support for read/write operations, file system traversal, metadata extraction, and more.


🚀 Features

  • ✅ Fully compatible with Claude Desktop
  • 📂 Read, write, move, delete, and search files
  • 🔒 Path validation & permission control
  • 🧠 JSON-RPC 2.0 communication over stdin/stdout
  • 🔄 Asynchronous architecture with asyncio
  • 🧪 Unit & integration tests included

🧰 Tech Stack

  • Python 3.11
  • AsyncIO, Pathlib, JSON, Typing
  • Claude Desktop (latest version)
  • MCP Protocol (v1.0) implementation

📦 Installation

Install uv (recommended)

On Windows PowerShell:

powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

On Linux/Mac:

curl -LsSf https://astral.sh/uv/install.sh | sh

or if your system does not have curl, try with wget

wget -qO- https://astral.sh/uv/install.sh | sh

or install by requesting a specific version

curl -LsSf https://astral.sh/uv/0.7.20/install.sh | sh

Make sure uv is available in your system PATH.

git clone https://github.com/yourusername/python-mcp-filesystem-server.git
cd python-mcp-filesystem-server
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
pip install -r requirements.txt

⚙️ Configuration

Edit config/windows.json, config/macos.json, config/default.json to define allowed paths and other settings:

windows.json
{
  "allowed_paths": [
    "C:\\Users\\username\\Desktop",
    "C:\\Users\\username\\Downloads"
  ],
  "max_file_size": "20MB",
  "allowed_extensions": [
    "txt", "md", "pdf", "png", "jpg","jpeg", "json", "docx", "doc", "ppt", "pptx", "xls", "xlsx"
  ]
}
macos.json
{
  "allowed_paths": [
    "/Users/username/Desktop",
    "/Users/username/Downloads"
  ],
  "max_file_size": "20MB",
  "allowed_extensions": [
    "txt", "md", "pdf", "png", "jpg","jpeg", "json", "docx", "doc", "ppt", "pptx", "xls", "xlsx"
  ]
}
default.json
{
  "allowed_paths": [
    "~/Desktop",
    "~/Downloads"
  ],
  "max_file_size": "20MB",
  "allowed_extensions": [
    "txt", "md", "pdf", "png", "jpg","jpeg", "json", "docx", "doc", "ppt", "pptx", "xls", "xlsx"
  ]
}

Configure Claude Desktop as follows:

{
  "mcpServers": {
    "python-filesystem": {
      "command": "C:\\Users\\username\\.local\\bin\\uv.EXE",
      "args":[
        "run",
        "--with",
        "mcp[cli]",
        "mcp",
        "run",
        "C:\\Users\\username\\Documents\\filesystem_mcp_server\\src\\main.py"
      ]
    }
  }
}

🛠️ Tools / API Functions

  • read_file, write_file, edit_file
  • list_directory, create_directory, move_file, delete_file
  • search_files, get_file_info

All handlers are fully async and support detailed logging and secure validations.


🧪 Testing

pytest tests/

Includes unit tests for:

  • File I/O
  • Security module
  • Server error handling
  • Config parsing

🧯 Known Issue

We encountered a server startup failure caused by Claude Desktop not correctly spawning the Python subprocess for MCP communication. This is likely due to how Claude resolves binary paths, especially on Windows or when the virtual environment is not activated globally.

Temporary Workaround:

Ensure Python is globally available in your $PATH or use a wrapper script to launch the server. Also, double-check that --config paths are correct and readable.


🤝 Contributing

We welcome contributions! Whether it's bug fixes, new features, or documentation, feel free to fork the repo and submit a PR. Please check the CONTRIBUTING.md (coming soon) for guidelines.


📜 License

MIT License


🙌 Acknowledgements

About

A local Python-based MCP server enabling Claude Desktop to interact with your filesystem using natural language commands. Includes CRUD file operations, security layer, and full Claude integration.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages