Skip to main content

MCP server for filesystem search and manipulation with granular search, content search and file edits

Project description

MCP Filesystem Server (Encoding Supported)

A Model Context Protocol (MCP) server for filesystem operations, optimized for intelligent interaction with large files and covering various text encodings (like UTF-8, EUC-KR).

Quick Setup with uvx

You can easily run this MCP server using uvx (the execution tool provided by uv). To configure this server in your MCP client (such as Claude Desktop or Antigravity), add the following to your configuration file:

MCP Client Configuration

Add the following JSON to your MCP settings file (For Claude Desktop):

  • macOS/Linux: ~/Library/Application Support/Claude/claude_desktop_config.json
  • Windows: %APPDATA%/Claude/claude_desktop_config.json
{
  "mcpServers": {
    "mcp-filesystem-encoding": {
      "command": "uvx",
      "args": [
        "mcp-filesystem-encoding",
        "C:\\Users\\username\\Desktop\\Test",
        "C:\\Users\\username\\Documents\\Projects"
      ]
    }
  }
}

Note: The arguments provided after the package name act as your Allowed Root Directories.

  • Multiple Paths Supported: You can specify as many root directories as you need by adding them as separate string arguments in the args array (e.g., "C:\\dir1", "C:\\dir2", etc.).
  • Security Boundary: The MCP server will strictly restrict its file operations (read, write, search) to only these listed directories and their subdirectories.

Important Variables & Usage Guidelines

1. Using the path Variable (Config & Tools)

  • At Server Setup: Provide the allowed root paths in your args list (as shown above).
  • During Tool Execution: When the MCP client (AI) uses tools like read_file or search_files, it must specify the fully qualified absolute path (e.g., C:\Users\username\Desktop\Test\file.txt). If the AI requests a path outside of the configured root directories, the server will deny access.

2. The encoding Option

This extended MCP server natively supports reading, writing, and searching files across different encodings, preventing character corruption in non-UTF-8 local environments (such as Korean euc-kr / cp949, or Japanese shift-jis).

The encoding parameter is optional (defaults to "utf-8") and is readily available across the following tool operations:

  • Examine Content: read_file, read_multiple_files, head_file, tail_file
  • Modify Content: write_file, edit_file
  • Discover Content: search_files (for precise text matching), grep_files (advanced Regex searches requiring decoding of target files)

Usage Example in MCP Call:

// Example: Reading a legacy Korean document
{
  "path": "C:\\Users\\Username\\Documents\\legacy_document.txt",
  "encoding": "euc-kr"
}

Available Tools Summary

  • Basic IO: read_file, write_file, edit_file
  • Search: search_files, grep_files
  • File System: list_directory, create_directory, directory_tree
  • Analytics: compare_files, find_duplicate_files

(All internal tools strictly enforce the path policy boundaries and seamlessly support the encoding option to empower your environment without breaking localized text!)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mcp_filesystem_encoding-0.2.4.tar.gz (96.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mcp_filesystem_encoding-0.2.4-py3-none-any.whl (33.5 kB view details)

Uploaded Python 3

File details

Details for the file mcp_filesystem_encoding-0.2.4.tar.gz.

File metadata

  • Download URL: mcp_filesystem_encoding-0.2.4.tar.gz
  • Upload date:
  • Size: 96.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.4 {"installer":{"name":"uv","version":"0.10.4","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for mcp_filesystem_encoding-0.2.4.tar.gz
Algorithm Hash digest
SHA256 6269772a6a845f2617038ae294949cfb0f6b6e72efe288a2185a891e7be5b2ae
MD5 4b521f59f1cccd2a658ebe8436a999c8
BLAKE2b-256 9f4c955bcdb40c5943c6c9638c49dd13cc8aa01583fd0317e462ffe68a0a6bc4

See more details on using hashes here.

File details

Details for the file mcp_filesystem_encoding-0.2.4-py3-none-any.whl.

File metadata

  • Download URL: mcp_filesystem_encoding-0.2.4-py3-none-any.whl
  • Upload date:
  • Size: 33.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.4 {"installer":{"name":"uv","version":"0.10.4","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for mcp_filesystem_encoding-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 5ef70756df50fd21558dc348971012c9aabd3ba532a6800638361aa9d31b4a30
MD5 df297e0bee58467840282b3fbc30eda1
BLAKE2b-256 32f7c272f2500f82c8d4b4d8c9bb777be5e42c9f9c5a45398220a4838ef62e09

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page