Filesystem Context

io.github.j0hanz由 GitHub 账号 j0hanz 发布v1.0.9更新于 Oct 24, 2026

🔍 Read-only MCP server for secure filesystem exploration, searching, and analysis

已验证STDIO仅桌面文件与存储开发者工具

概览

AI 生成的概览

一个本地 MCP 服务器,让 AI 助手在你明确允许的文件夹内进行受限的读取、搜索、对比和编辑操作。

可以做什么
Filesystem Context 在你的机器上运行,提供 13 个文件工具:以树状列出文件夹、按名称或 glob 查找文件、用字面文本或 RE2 正则像 grep 一样搜索文件内容、用 stat 获取大小与 token 估算、整份或按行范围读取一个或多个文件、对比两个文件的统一 diff,以及创建、编辑、打补丁、跨文件替换文本、移动、复制和删除文件。搜索与列目录默认跳过隐藏文件、.gitignore 中的文件和依赖目录。--read-only 参数会移除所有写入类工具。
适用场景
适合让助手在特定项目或文档文件夹内工作:查找 TODO、跨文件重命名符号、比较配置文件、读取日志尾部或整理文件。当你希望文件访问仅限于选定目录,并希望写入可预览或被禁止时,它很合适。
运行要求
需要 Node.js 24 或更高版本,通过 npx 或全局安装 npm 包 @j0hanz/filesystem-context-mcp 运行;也支持 Docker。必须把一个或多个允许的文件夹路径作为参数传入。默认使用 stdio,也可用 --port 启用 Streamable HTTP。未声明账号、API 密钥或环境变量。
安装前请注意
写入类工具(create、edit、patch、replace_text、move、delete)会改动磁盘文件;edit、patch 和 replace_text 不会询问就直接应用,若不想有任何改动可使用 dryRun 或 --read-only。create 和 move 在覆盖前会询问,除非传入 overwrite: true;delete 在删除非空文件夹前会询问。.env、密钥和云凭据等敏感文件默认被阻止,但可用 --allow 解除。通过 HTTP 使用时,非 localhost 地址需要 API 密钥,且 2025 版协议的 HTTP 客户端不会收到确认提示。

安装

在 SourceWeft 中

  1. 打开 控制台中的 Filesystem Context,将其添加到工作区。
  2. 为需要使用其工具的对话启用该服务。

Desktop only,通过 STDIO。 STDIO 服务会启动本地进程,因此需要 SourceWeft 桌面宿主。

其他 MCP 客户端

参照 仓库 中的启动说明。

README

[Filesystem MCP logo]

Filesystem MCP

Let your AI assistant work with your files, safely.

Read, search, edit, and patch files in the folders you choose.
Secret files stay hidden, and risky changes wait for your OK.

[npm version] [CI] [License: MIT] [GitHub stars] [HOL Trust] [Filesystem MCP security badge] [Filesystem MCP status badge]

[Install in VS Code] [Install in VS Code Insiders] [Install in Visual Studio] [Install in Cursor] [Install in Claude Desktop]

[filesystem-mcp MCP server – quality and maintenance score on Glama]

[The example web client lists a folder with .env hidden, the server refuses to open .env, then asks before overwriting README.md and keeps the file when told to skip]

What is this?

Model Context Protocol (MCP) is how AI apps such as Claude, GitHub Copilot in VS Code, and Cursor connect to tools. Filesystem MCP is an MCP server: a small program that runs on your computer and gives the AI 14 tools for working with files. You choose which folders it can use, and everything outside them is off limits.

Once it is connected, you can ask things like:

  • "Find every TODO in this repo and group them by file."
  • "Rename getUser to fetchUser in all .ts files. Show me the diff first."
  • "What changed between config.dev.json and config.prod.json?"
  • "Read the last 50 lines of server.log and explain the error."
  • "Move the old screenshots into archive/2025/."

Why Filesystem MCP?

  • It is safe by default. The AI can use only the folders you allow, and .env files, private keys, and cloud credentials are blocked. The server asks you before the AI deletes a non-empty folder, opens a folder you did not allow, or writes over a file with create or move. Only create and copies can skip that question, by passing overwrite: true. Edits made with edit, patch, and replace_text apply without asking, but the AI can show you the diff first with dryRun. If the AI should never change anything, --read-only removes every tool that writes.
  • Search and editing are made for code. The AI can search inside files like grep, with a regex engine (RE2) that cannot hang, and by default the server skips .gitignored files and folders like node_modules. Edits are exact-match replacements that return an error when the text does not match, and you can preview them as a diff first.
  • It saves the AI's context. The AI can read many files in one call or only the lines it needs, and it can check a file's size and token estimate before reading it.
  • It works with any MCP client, over stdio or HTTP, on macOS, Linux, and Windows. You can install it with npx, Docker, or a one-click Claude Desktop extension, or build your own client on it.
  • It is private. It runs on your machine, has no telemetry, and makes no network calls.

Compared with the reference server

How this server differs from the official @modelcontextprotocol/server-filesystem, checked against its README on 2026-11-02:

CapabilityFilesystem MCPReference server
Search inside filessearch_text: literal text or RE2 regexNone; search_files matches names only
Secret files.env, keys, and credentials blocked by defaultNot blocked
Overwriting a filecreate asks you first (unless overwrite: true)write_file overwrites without asking
Delete filesdelete; asks before deleting a non-empty folderNone
.gitignoreRespected by listing and search toolsNot supported
Read-only mode--read-only removes every tool that writesDocker ro mounts only
Per-folder read-only--read-only-root guards chosen foldersDocker ro mounts only
Apply a unified diffpatchNone
Compare two filesdiffNone
Replace across many filesreplace_text over a folder or globNone
Watch filesSubscribe to a file and get change notificationsNone
Transportstdio, or Streamable HTTP with --portstdio

Quick start

[!NOTE] You need Node.js 24 or later. Check with node --version.

  1. Add the server to your AI app. Pick yours below.
  2. Replace /path/to/project with the folder the AI may use. You can list several folders.
  3. Restart the app and ask: "Which folders can you access?"

[!TIP] VS Code currently shares the folders you have open with the server, so the one-click VS Code install works without a path. In other apps, or over HTTP, put the folder in args. If the AI says it has no folders, that is the fix.

VS Code

Click Install in VS Code above, or add this to .vscode/mcp.json:

json
{  "servers": {    "filesystem": {      "command": "npx",      "args": ["-y", "@j0hanz/filesystem-mcp@latest", "/path/to/project"]    }  }}

Or from a terminal:

sh
code --add-mcp '{"name":"filesystem","command":"npx","args":["-y","@j0hanz/filesystem-mcp@latest","/path/to/project"]}'
Cursor

Click Install in Cursor above, then add your folder to args. Or add this to .cursor/mcp.json in your project, or ~/.cursor/mcp.json for all projects:

json
{  "mcpServers": {    "filesystem": {      "command": "npx",      "args": ["-y", "@j0hanz/filesystem-mcp@latest", "/path/to/project"]    }  }}
Claude Desktop

For a one-click install, download filesystem-mcp.mcpb, open it with Claude Desktop, and pick the folders to allow. Claude Desktop's built-in Node.js runs it. The extension's settings also let you turn on read-only mode and block more files.

To set it up by hand, add this to claude_desktop_config.json (Settings → Developer → Edit Config):

json
{  "mcpServers": {    "filesystem": {      "command": "npx",      "args": ["-y", "@j0hanz/filesystem-mcp@latest", "/path/to/project"]    }  }}
Claude Code
sh
claude mcp add filesystem -- npx -y @j0hanz/filesystem-mcp@latest /path/to/project

Or install the plugin, which points the server at your current project:

text
/plugin marketplace add j0hanz/j0hanz-marketplace/plugin install filesystem-mcp@j0hanz-marketplace
Visual Studio

Add this to .vs\mcp.json in your solution folder, or %USERPROFILE%\.mcp.json for all solutions:

json
{  "servers": {    "filesystem": {      "command": "npx",      "args": ["-y", "@j0hanz/filesystem-mcp@latest", "C:/path/to/project"]    }  }}
GitHub Copilot CLI and Antigravity CLI (plugin)

The filesystem-mcp plugin sets the server up for your current project:

ClientInstall
Copilot CLIcopilot plugin marketplace add j0hanz/j0hanz-marketplace, then copilot plugin install filesystem-mcp@j0hanz-marketplace
Antigravity CLIgit clone https://github.com/j0hanz/j0hanz-marketplace, then agy plugin install ./j0hanz-marketplace/plugins/filesystem-mcp
Docker

The container can only see the folders you mount. This setup blocks writes twice, with the :ro mount and with the --read-only flag.

json
{  "mcpServers": {    "filesystem": {      "command": "docker",      "args": [        "run",        "-i",        "--rm",        "-v",        "/path/to/project:/workspace:ro",        "ghcr.io/j0hanz/filesystem-mcp:latest",        "--read-only",        "/workspace"      ]    }  }}

Drop :ro and --read-only to let the AI make changes. VS Code and Visual Studio use "servers" instead of "mcpServers". See Running in Docker for more.

Other MCP clients

Windsurf, Cline, and most other clients use the same mcpServers JSON as Claude Desktop above. In any client, the server is:

  • command: npx
  • args: -y, @j0hanz/filesystem-mcp@latest, then one or more folders

You can also install it globally and run filesystem-mcp /path/to/project:

sh
npm install -g @j0hanz/filesystem-mcp

Tools

ToolWhat it does
list_rootsShows the folders the server may use.
listLists a folder as a tree, like ls or tree.
find_filesFinds files by name or glob, such as **/*.test.ts.
search_textSearches inside files for text or a regex, like grep, with optional context lines.
statGets size, dates, type, permissions, and a token estimate without reading the file.
readReads text files whole or by lines, head, or tail. Images and audio come back as media; others with binary.
diffCompares two files and returns a unified diff.
create ✎Writes new files, appends, or makes empty folders. Asks before replacing a file, unless overwrite: true.
edit ✎Replaces exact text in files. All edits to a file apply, or none do. dryRun shows the diff first.
patch ✎Applies a unified diff to a file. All hunks apply, or none do.
replace_text ✎Finds and replaces text or a regex across many files. dryRun shows what would change.
move ✎Moves, renames, or copies files and folders. Asks before overwriting, unless a copy passes overwrite: true.
delete ✎Deletes files and folders. Asks before deleting a non-empty folder.
undo ✎Reverts recent changes by undo id or the last N calls, for 30 minutes while the server runs. Skips files changed since.

✎ changes files. --read-only removes these tools. To refuse changes under one folder while the rest stay writable, pass --read-only-root <dir> (repeatable, or FS_READ_ONLY_DIRS): those tools still exist, but a call that writes, moves, or deletes under the folder fails with Read-only root: ..., while listing, searching, and reading keep working.

Search and listing tools skip hidden files, .gitignored files, and folders like node_modules, dist, and .git unless the AI asks for them.

Configuration

Most people only need the folder argument. These options cover the common cases:

OptionWhat it does
--read-onlyRemoves every tool that changes files.
--read-only-root <dir>Refuses writes, moves, and deletes under this folder, which stays readable. Repeatable.
--deny '<pattern>'Blocks more files, for example --deny 'private/**' or --deny '*.sqlite'.
--allow '<pattern>'Unblocks one built-in secret pattern, for example --allow '.env.example'.
--allow-cwdAlso allows the folder the server was started from.
--max-file-size <n>Largest file read will load, in bytes. Default 10 MiB.
--port <n>Serves over HTTP at http://127.0.0.1:<n>/mcp instead of stdio.
--print-configPrints the settings the server would use, then exits.

Flags go in args after the package name, for example ["-y", "@j0hanz/filesystem-mcp@latest", "--read-only", "/path/to/project"].

The full configuration reference covers every flag and environment variable, the complete secret-file list, limits, HTTP setup with API keys, Docker, and troubleshooting.

Security

ProtectionHow it works
Folder sandboxThe server resolves every path, including symlinks, and the resolved path must stay inside an allowed folder.
Secret files.env, *.pem, *.key, SSH keys, .npmrc, cloud credentials, and more are blocked and hidden from listings.
You stay in chargeThe server asks you before the AI deletes a non-empty folder, gets access to a new folder, or writes over a file with create or move. Only create and copies skip that question, when the AI passes overwrite: true. In-place edits (edit, patch, replace_text) do not ask, but dryRun previews them. A client that cannot ask gets an error instead.
Off-limits foldersNeither the AI nor the client can ever add your home folder itself, system folders, or ~/.ssh, ~/.aws, and similar folders.
Safe writesNew content goes to a temporary file that is then renamed into place, so a crash never leaves a half-written file. Writes keep the file's permissions.
No regex hangsRE2 runs in linear time, so no search pattern can freeze the server.
HTTPThe server listens only on localhost by default. Any other address requires an API key.
ContainerThe Docker image runs as a non-root user.

If you find a vulnerability, please report it privately. SECURITY.md explains how.

Build your own client

You can also call Filesystem MCP from your own code: an agent, an editor plugin, a web app, a CI job, or a script. The same rules apply as for an AI app, so your code cannot reach outside the allowed folders or read secret files.

ts
import { Client } from '@modelcontextprotocol/client';import { StdioClientTransport } from '@modelcontextprotocol/client/stdio';
const dir = '/path/to/project';const client = new Client(  { name: 'my-app', version: '1.0.0' },  { capabilities: { elicitation: { form: {} } }, versionNegotiation: { mode: 'auto' } },);client.setRequestHandler('elicitation/create', async () => ({ action: 'decline' }));await client.connect(  new StdioClientTransport({    command: 'npx',    args: ['-y', '@j0hanz/filesystem-mcp', dir],    cwd: dir,  }),);
const result = await client.callTool({ name: 'search_text', arguments: { searchPattern: 'TODO' } });const { matches } = (result.structuredContent ?? result._meta) as { matches: unknown[] };console.log(matches);await client.close(); // stops the server process; without it the script never exits

The basics:

  • Where the data is. The text block is written for a model. The same data as JSON is in _meta for tools that write their own text (list, search_text, edit, ...) and in structuredContent for stat, create, and list_roots. read is the exception: the file's text is only in the text block, and _meta holds metadata about it.
  • Paths. A relative path resolves against the server's working directory when that is inside a root, and against the root otherwise. With several roots, it must exist under exactly one of them. Absolute paths are never ambiguous. Search results are printed relative to the root, so a result can be passed straight back. A name that differs from the one on disk only in Unicode form (NFC or NFD) or in its space characters (U+00A0, U+202F) finds that entry.
  • Confirmations. Overwrites, recursive deletes, and paths outside the roots are questions for the user. Declare the elicitation capability and answer them in a handler, or, on the 2026-07-28 protocol, take them as data (input_required) and answer later.
  • Protocol versions. The server speaks the 2025 protocol and 2026-07-28, over stdio and Streamable HTTP. Over HTTP, 2025-era clients get no confirmations or change notifications.
  • Resources. Read and subscribe to any file as filesystem-mcp://file/{+path}; internal://instructions and the get-help prompt hold the server's guide for models.

The client guide has the details, tested with the TypeScript and Python SDKs, and examples/ has six runnable clients:

ExampleWhat it is
fsqAny tool from your shell, over stdio or HTTP; --json for scripts
browserA local web UI where the server's questions appear in the page
tailtail -f through file subscriptions, locally or on a remote server
gatekeeperA coding agent that shows each change's diff and waits for your y/N
hooksRuns a task through a model whenever the workspace changes
pythonA TODO report for a workspace, with the Python SDK

Privacy policy

Filesystem MCP runs entirely on your machine. This policy covers the npm package, the Docker image, and the .mcpb desktop extension.

  • Data collection: none. The server has no telemetry, analytics, or crash reporting, and makes no outbound network requests.
  • Use and storage: the server reads and writes files only inside the folders you allow, and only when your MCP client calls a tool. Tool results go to that client and nowhere else. Short-lived result caches and the undo history (saved file contents) live in memory and disappear when the server exits.
  • Third-party sharing: none by this server. Your MCP client may send tool results to its model provider under that client's own privacy policy.
  • Retention: the server keeps nothing after the process exits. Diagnostic logs go to stderr on your machine; your MCP client may save them in its own log files.
  • Contact: open an issue at https://github.com/j0hanz/filesystem-mcp/issues, or report security problems privately through GitHub Security Advisories.

Contributing

Bug reports, ideas, and pull requests are welcome. Start with CONTRIBUTING.md. It covers setup, running the server from source, and the checks a pull request needs.

If Filesystem MCP is useful to you, a star on GitHub helps other people find it.

[Contributors]

License

MIT

来源:README.md,提交 de5eef7

工具

0
SourceWeft 尚未在沙箱中启动过该软件包,因此其工具未知。

版本历史

1
  1. v1.0.9最新Sep 16, 2026

评分

已满足适用检查项的 50%

该评分衡量此收录条目的完整程度,依据注册中心条目、端点与公开来源计算得出。它不是对服务器本身的评价,也不表示服务器安全或当前可用:可连通性是带日期的检查结果,评分也不包含安装量或用户评价。

  • 近 30 天内可连通25 分

    请保持端点能够响应 MCP 握手;SourceWeft 每 30 天探测一次。

  • 已声明认证方式10 分

    请在注册中心条目中声明凭据请求头,或保持端点能够响应探测,以便判定其认证方式。

  • 已列出工具15 分

    请让服务器在无凭据时响应 tools/list,或发布可在沙箱中无凭据启动的软件包。

  • 描述必需15 分
  • 图标10 分
  • 文档15 分
  • 许可证10 分