FileSystem MCP Server

io.github.Oncorporation由 GitHub 帳號 Oncorporation 發布v0.1.4更新於 Oct 24, 2026

Secure filesystem access for AI agents with configurable directory and file type restrictions

已驗證STDIO僅桌面檔案與儲存開發者工具

概覽

AI 產生的概覽

本機 MCP 伺服器,讓 AI 助理在限定目錄與檔案類型範圍內讀取專案檔案,並可選擇開啟寫入功能。

可以做什麼
  • 列出目錄與資源,支援進度回報與分批處理
  • 讀取文字檔,或以 base64 讀取二進位檔
  • 檢視檔案或目錄的中繼資料與可用動作
  • 透過 init 檢查驗證已設定的目錄與設定來源
  • 僅在明確開啟寫入後寫入文字或二進位檔
適用情境
適合在 Visual Studio 2022+ 等本機開發環境中,讓助理讀取與瀏覽單一專案目錄,而不需要多根工作區。也適合需要把檔案系統存取嚴格限制在指定目錄與副檔名的情境。
執行需求
以 Python 套件形式透過 stdio 在本機執行(從原始碼安裝需 Python 3.10+)。需要設定允許的目錄與允許的副檔名,可透過命令列參數或放在 MCP 設定檔旁的 config.json 提供。未宣告帳號、API 金鑰或環境變數。
安裝前請注意
寫入工具會覆寫既有檔案,預設關閉,僅在需要時開啟。存取雖受設定目錄與副檔名限制,但伺服器以目前使用者帳戶權限執行,應盡量縮小允許目錄範圍。設定檔會包含真實的本機路徑。

安裝

在 SourceWeft 中

  1. 開啟 儀表板中的 FileSystem MCP Server,將其新增到工作區。
  2. 為需要使用其工具的對話啟用該服務。

Desktop only,透過 STDIO。 STDIO 服務會啟動本機處理程序,因此需要 SourceWeft 桌面主機。

其他 MCP 客戶端

參照 儲存庫 中的啟動說明。

README

FileSystem MCP Server

Version: 0.1.4 — Last updated: 2026-10-13

Local MCP server for Visual Studio 2022+ that provides code-workspace functionality by giving AI agents selective access to project folders and files

Table of Contents


🎯 Target Environment

This MCP server is optimized for:

  • Visual Studio 2022+ development workflows
  • Local development environments without complex workspace setups
  • Direct folder access scenarios where you need filesystem operations
  • Development environments that don't use .code-workspace files
  • Individual project directories rather than multi-root workspaces

Features

  • Directory Traversal: List contents of allowed directories
  • File Reading: Read contents of files with allowed extensions
  • File Writing: Write text/binary content to files — opt-in via --allow-write (disabled by default)
  • Directory Validation: Check accessibility of configured directories
  • Hybrid Configuration: Command-line arguments (MCP) + config.json fallback (debugging)
  • Visual Studio 2022+ Debugging: No-argument startup support
  • Cross-Platform Path Support: Automatically handles both Windows (\) and Unix (/) path separators
  • Security: Access restricted to explicitly specified directories and file types
  • Local Development Focus: Perfect for Visual Studio 2022+ and similar environments

Installation

From PyPI (Recommended for Users)

bash
pip install vs-filesystem-mcp-server

From Source (For Development)

  1. Ensure you have Python 3.10+ installed

  2. Clone the repository

  3. Navigate to the project directory

  4. Install dependencies using uv:

    bash
    uv sync

Quick Start

  1. For MCP usage: Add the corrected configuration to your .mcp.json
  2. For debugging: Just press F5 in Visual Studio 2022+ - uses config.json automatically
  3. Test your configuration by calling the init() tool first
  4. If init() returns errors, check your directory paths and permissions

Configuration Options

Option 1: Config.json File (Simplest - Recommended for Beginners)

The easiest way to get started! Create a config.json file:

For MCP server usage:

  • Place config.json in the same folder as your .mcp.json file (usually C:\Users\YourUsername\)

For debugging from source (Visual Studio 2022+):

  • Place config.json in the same directory as app.py (D:/Projects/filesystem_server/)
json
{  "allowed_dirs": [    "C:/Users/YourUsername/Documents/projects",    "D:/projects",    "D:/Webs"  ],  "allowed_extensions": [    ".py", ".js", ".ts", ".json", ".md", ".txt",    ".yml", ".yaml", ".toml", ".cfg", ".ini", ".cs",    ".css", ".scss", ".htm", ".html", ".xml", ".xaml"  ],  "allow_write": false}

Note: Set "allow_write": true to enable write_file and write_file_binary tools.

MCP Configuration (Installed via pip)

Add this to your .mcp.json file (usually C:\Users\YourUsername\ in VS 2022+):

json
{  "servers": {    "filesystem-server": {      "command": "vs-filesystem-mcp-server"    }  }}

Note: When installed via pip, the command is just vs-filesystem-mcp-server - no path to app.py needed!

MCP Configuration (Running from Source)

If you're developing and running from source code:

json
{  "servers": {    "filesystem-server": {      "command": "python",      "args": [        "/absolute/path/to/your/project/filesystem_server/app.py"      ],      "cwd": "/absolute/path/to/your/project/filesystem_server"    }  }}

Benefits:

  • ✅ No command-line arguments needed
  • ✅ Perfect for Visual Studio 2022 debugging (just press F5)
  • ✅ Works with MCP clients when placed in correct location
  • ✅ Easy to edit and modify
  • ✅ Great for testing and development

Usage:

bash
# For debugging in Visual Studio 2022:python app.py  # Uses config.json from same directory as app.py
# For MCP server usage:# The MCP client automatically finds config.json in the .mcp.json directory

Important Location Notes:

  • 🔧 Debugging: config.json goes next to app.py
  • 🌐 MCP Server: config.json goes next to .mcp.json
  • 📁 Different locations for different use cases!

Option 2: Command-Line Arguments (Advanced - For MCP Clients)

Best for production MCP client configurations where you want everything in one place:

When Installed via pip
json
{  "servers": {    "filesystem-server": {      "command": "vs-filesystem-mcp-server",      "args": [        "--allowed-dirs", "D:/projects", "D:/Webs",        "--allowed-extensions", ".py", ".js", ".ts", ".json", ".md", ".txt"      ]    }  }}
When Running from Source
bash
python app.py --allowed-dirs "D:/projects" "D:/Webs" --allowed-extensions ".py" ".js" ".md"
# With write access enabled:python app.py --allowed-dirs "D:/projects" "D:/Webs" --allowed-extensions ".py" ".js" ".md" --allow-write true

MCP Client Configuration (.mcp.json):

json
{  "servers": {    "filesystem-server": {      "command": "python",      "args": [        "/absolute/path/to/your/project/filesystem_server/app.py",        "--allowed-dirs", "D:/projects", "D:/Webs",        "--allowed-extensions", ".py", ".js", ".ts", ".json", ".md", ".txt"      ],      "cwd": "/absolute/path/to/your/project/filesystem_server"    }  }}

Benefits:

  • ✅ Self-contained configuration
  • ✅ No external config files needed
  • ✅ Version control friendly
  • ✅ Explicit and visible in MCP setup

Option 3: Hybrid Approach (Best of Both Worlds)

The server automatically uses command-line arguments first, then falls back to config.json if no arguments provided.

How it works:

  • MCP clients: Use command-line arguments (Option 2)
  • Visual Studio debugging: Automatically uses config.json (Option 1)
  • Priority: Command-line args override config.json when present

Benefits:

  • ✅ Works for both MCP clients and debugging
  • ✅ No conflicts between different usage scenarios
  • ✅ Flexible and developer-friendly
  • ✅ Choose the best option for each situation

Usage

Command Line Examples

bash
# With command line arguments (MCP clients):python app.py --allowed-dirs "D:/projects" "D:/Webs" --allowed-extensions ".py" ".js" ".md"
# Using config.json fallback (Visual Studio 2022+ debugging):python app.py
# Show MCP configuration help:python app.py --help-mcp

Available Tools

  1. init(directory, file_path) - Validates accessibility of configured directories and can optionally list a directory and/or read a file

    • directory (optional): Directory path to list contents (can be None)
    • file_path (optional): File path to read content (can be None)
    • Returns { "message": "OK", "isError": false, ... } if all directories accessible
    • Returns error details if any directories are inaccessible
    • Shows configuration source (command-line args vs config file)
    • Use this to verify your configuration before using other tools
  2. list_directory(directory, report_progress=True, batch_size=100) - Lists files and subdirectories in a given directory, with optional progress reporting

    • directory: The absolute or relative path to the directory (supports both / and \ separators)
    • report_progress (optional): If True, returns progress information and batch details (default: True)
    • batch_size (optional): Number of items to process before reporting progress (default: 100)
    • Returns a list of file and directory names if report_progress is False
    • Returns a dictionary with contents, progress_info, total_items, and processing_time if report_progress is True
    • If an error occurs, returns a dictionary with "error" and "error_message" keys
    • No exceptions are raised - all errors are returned as part of the result
  3. read_file(file_path) - Reads the content of a specified file as text

    • Returns the file content as a string (for text files only)
    • Not suitable for binary files (images, audio, etc.)
  4. read_file_binary(file_path) - Reads the content of a specified file as base64-encoded binary

    • Returns { "content_base64": <base64 string>, "encoding": "base64", "error": False } on success
    • Returns an error dict if the file is not allowed or not found
    • Suitable for images, audio, and other binary files
  5. list_resources(directory=None, report_progress=True, batch_size=100) - Lists all resources (files and directories) in a directory (or all allowed directories) in MCP resource format

    • directory (optional): Directory to start from (defaults to all allowed_dirs)
    • report_progress (optional): If True, returns progress information and batches (default: True)
    • batch_size (optional): Number of resources per progress batch (default: 100)
    • Returns a list of resource objects if report_progress is False
    • Returns a dictionary with contents, progress_info, total_items, and processing_time if report_progress is True
    • Example resource object:
      json
      {  "id": "D:/projects/example.txt",  "type": "file",  "name": "example.txt",  "path": "D:/projects/example.txt",  "metadata": {    "size": 1234,    "modified": "2025-08-18T12:34:56Z"  },  "actions": ["read", "read_binary", "write", "write_binary"]}
  6. get_resource(path) - Gets metadata and actions for a specific file or directory

    • path: Absolute or relative path to the resource
    • Returns a resource object (id, type, name, path, metadata, actions) or an error dict
    • For files, includes size and modified time; for directories, includes type and actions
    • Does not return file content
  7. write_file(file_path, content) - Writes text content to a specified file (requires --allow-write)

    • file_path: Path to write to (must be within allowed dirs)
    • content: Text string to write
    • Raises ValueError if write access is disabled, path not allowed, extension not allowed, or IO error
    • Overwrites existing file
    • Disabled by default — enable with --allow-write flag or "allow_write": true in config.json
  8. write_file_binary(file_path, content_base64) - Writes binary content from base64 to file (requires --allow-write)

    • file_path: Path to write to (must be within allowed dirs)
    • content_base64: Base64-encoded binary data
    • Returns {"success": true, "bytes_written": int, "error": false} or error dict
    • Overwrites existing file, suitable for images/binaries
    • Disabled by default — enable with --allow-write flag or "allow_write": true in config.json

Why This Hybrid Approach is Perfect

  • ✅ MCP clients: Use efficient command-line arguments
  • ✅ Visual Studio 2022: Zero-friction debugging with config.json fallback
  • ✅ No conflicts: Priority system handles both scenarios gracefully
  • ✅ Developer-friendly: Works however you want to run it
  • ✅ Best of both worlds: MCP efficiency + debugging convenience

Visual Studio 2022+ Debugging

Perfect debugging experience:

  • ✅ No command-line arguments needed
  • ✅ Just press F5 to start debugging
  • ✅ Automatically uses config.json
  • ✅ Set breakpoints and debug normally
  • ✅ Full IntelliSense and debugging support

Debugging setup:

  1. Open the project in Visual Studio 2022
  2. Ensure config.json exists (already created for you)
  3. Press F5 or Debug > Start Debugging
  4. Server starts with your configured directories

Visual Studio 2022+ Usage Examples

Below are step-by-step examples showing how to call the FileSystem MCP Server from within Visual Studio 2022. These screenshots demonstrate the process using the alias "fss" for the server, which is simply a shorter name for "filesystem-server". You can customize this alias in your .mcp.json file—the actual name is up to you.

Note: All images are located in the images/ subfolder.

Step 1: Calling the Server Tool

[Step 1: Example of calling the tool in Visual Studio 2022]

In this example, the MCP client is configured to use "fss" as the server name. This is just an alias for convenience.

Step 2: Viewing the Server Response

[Step 2: Example of viewing the server response in Visual Studio 2022]

The server responds with the results of your request, such as the output from the read_file() tool.


Note:

  • The "fss" alias is used here for brevity. You can use any name you prefer in your .mcp.json configuration.
  • To change the server name, simply update the key in your .mcp.json file from "filesystem-server" to any other name you like.

For more details on configuring your MCP client, see the Configuration Options section above.

Editing Your mcp.json File via GitHub Copilot Chat

You can easily edit your mcp.json configuration file directly from Visual Studio using the GitHub Copilot Chat interface. Follow these steps:

  1. Click the Tools icon on the right side of Visual Studio, while in Agent mode.
  2. Click the arrow next to any MCP server in the list.
  3. Choose Edit – the mcp.json file will open for editing.

[How to edit mcp.json using GitHub Copilot Chat]

This allows you to quickly update your MCP server configuration without leaving the IDE.

Security

  • Only directories specified in --allowed-dirs or config.json can be accessed
  • Only files with extensions in --allowed-extensions or config.json can be read or written
  • Write access disabled by default: write_file and write_file_binary require --allow-write flag or "allow_write": true in config.json
  • All paths are validated before access
  • The server runs with the permissions of the user account
  • Perfect for local development: Secure access to your project directories

Error Handling

The server provides detailed error messages for:

  • Unauthorized directory access
  • Invalid file paths
  • Unsupported file extensions
  • Missing configuration (shows helpful guidance for both MCP and debugging scenarios)
  • Directory accessibility issues (via init() tool)

New Error Handling for list_directory():

  • The list_directory() function now returns errors as part of the result list instead of raising exceptions
  • Error format: ["error", "detailed_error_message"]
  • This makes it easier for MCP clients to handle errors gracefully without exception handling
  • Successful calls return the normal list of directory contents

Troubleshooting

MCP Configuration Issues

Your original config had a missing comma after "D:/Webs". The corrected version above fixes this.

Visual Studio 2022+ Debugging

  1. Ensure config.json exists (already created for your directories)
  2. Start with the init() tool to validate your configuration
  3. Set breakpoints and debug normally
  4. Check output window for configuration source confirmation

Common Issues

  1. Missing configuration: The server shows helpful messages for both MCP and debugging scenarios
  2. Path access errors: Verify your directories exist and are accessible
  3. Permission issues: Check directory permissions on your configured paths
  4. MCP client issues: Use the corrected configuration above

Command Line Reference

bash
python app.py --help                         # Show helppython app.py --help-mcp                     # Show MCP configuration examples  python app.py --allowed-dirs DIR1 DIR2       # Set allowed directoriespython app.py --allowed-extensions EXT1 EXT2 # Set allowed extensionspython app.py --allow-write true             # Enable write tools (disabled by default)python app.py --allow-write false            # Explicitly disable write toolspython app.py --config custom.json           # Use custom config filepython app.py                                # Use config.json fallback (debugging)

Cross-Platform Path Support

The filesystem server automatically normalizes paths to handle different operating system conventions:

✅ Windows Users - Both Formats Work

json
{  "allowed_dirs": [    "D:\\projects",           // Windows-style backslashes    "F:/sd/wipes",           // Unix-style forward slashes      "C:\\Users\\Me\\Docs"    // Mixed formats work too  ]}

✅ Automatic Path Normalization

  • Input: "F:\sd\wipes" (Windows natural format)
  • Normalized: "F:/sd/wipes" (Python-friendly format)
  • Result: ✅ Works seamlessly, no errors!

✅ MCP Tool Examples

python
# All of these work identically:list_directory("F:\\sd\\wipes")    # Windows formatlist_directory("F:/sd/wipes")      # Unix format  list_directory("F:\\sd/wipes")     # Mixed format

Why This Matters

  • 🪟 Windows users can naturally type F:\sd\wipes
  • 🐧 Unix users can use traditional F:/sd/wipes
  • 🔧 No more path format errors - everything just works
  • 🛡️ Security checks work correctly regardless of separator style

Advanced & Real-World MCP Configuration Examples

For more advanced, platform-specific, or legacy MCP client configuration examples (including both "servers" and "mcpServers" formats), see the mcp_configuration_examples.json file in this repository.

This file includes:

  • Additional real-world setups for Windows, Linux, and macOS
  • Minimal web development configurations
  • Multiple directory and file type examples
  • Migration tips for moving from config.json to command-line arguments
  • Legacy MCP client support using the "mcpServers" format

Refer to it if you need more flexibility or are working with a non-standard MCP client.

[Buy Me A Coffee]

來源:README.md,提交 721a03d

工具

0
SourceWeft 尚未在沙箱中啟動過該軟體包,因此其工具未知。

版本歷史

2
  1. v0.1.4最新Oct 13, 2026
  2. v0.1.3Sep 16, 2026

評分

已滿足適用檢查項的 50%

該評分衡量此收錄條目的完整程度,依據註冊中心條目、端點與公開來源計算得出。它不是對伺服器本身的評價,也不表示伺服器安全或目前可用:可連通性是帶日期的檢查結果,評分也不包含安裝量或使用者評價。

  • 近 30 天內可連通25 分

    請保持端點能夠回應 MCP 握手;SourceWeft 每 30 天探測一次。

  • 已宣告認證方式10 分

    請在註冊中心條目中宣告憑證請求標頭,或保持端點能夠回應探測,以便判定其認證方式。

  • 已列出工具15 分

    請讓伺服器在無憑證時回應 tools/list,或發布可在沙箱中無憑證啟動的軟體包。

  • 描述必需15 分
  • 圖示10 分
  • 文件15 分
  • 授權條款10 分