markdownfs：为 Markdown 打造的虚拟文件系统

项目简介

markdownfs（简称 mdfs）是一款专为 Markdown 文件设计的虚拟文件系统，用 Rust 构建，提供高性能的内存存储和丰富的操作接口。它将传统文件系统的概念与版本控制、权限管理相结合，特别适合构建 AI Agent 工作空间或需要结构化 Markdown 管理的场景。

仓库地址：https://github.com/subramanya1997/markdownfs

核心特性

多模态访问

mdfs 提供五种使用方式，覆盖从终端到 Web 再到 AI 集成的全场景：

方式	入口	适用场景
CLI/REPL	`markdownfs` 二进制	终端交互使用
HTTP/REST API	`mdfs-server`	Web 应用、服务集成
MCP Server	`mdfs-mcp`	Cursor、Claude 等 AI Agent
TypeScript SDK	npm `markdownfs`	Node 18+/浏览器环境
Python SDK	PyPI `markdownfs`	Python 3.9+ 项目

Unix 风格命令行

熟悉 Linux 的用户会感到亲切——mdfs 支持常见的文件操作命令：

ls、cd、pwd 目录导航
touch、mkdir、rm 文件操作
cat、write 内容读写
chmod、chown 权限管理
管道和重定向支持

Git 式版本控制

内置内容寻址存储（CAS）和版本历史：

commit 创建快照
log 查看变更历史
revert 回滚到指定版本
自动去重存储

多用户权限系统

完整的 UNIX 风格权限模型：

用户和组管理
文件级权限控制（读/写/执行）
管理员权限委派
团队工作空间支持

并发安全

基于 tokio::RwLock 的核心设计，确保多读者/单写者的安全并发访问，适合服务端部署。

安装方法

从源码编译

git clone https://github.com/subramanya1997/markdownfs.git
cd markdownfs
cargo build --release

编译后会生成三个二进制文件：

markdownfs — CLI/REPL 交互工具
mdfs-server — HTTP 服务器
mdfs-mcp — MCP 协议服务器

TypeScript SDK

npm install markdownfs
# 或使用 Bun
bun add markdownfs

Python SDK

pip install markdownfs

使用示例

CLI 快速上手

启动后首次使用需要创建管理员账户：

$ cargo run --release --bin markdownfs

markdownfs v0.2.0 — Markdown Virtual File System

Welcome! Let's set up your account.
Admin username: alice

Created admin 'alice' (uid=1, groups=[alice, wheel])
Home directory: /home/alice

alice@markdownfs:~ $ touch hello.md
alice@markdownfs:~ $ write hello.md # 欢迎使用 mdfs
alice@markdownfs:~ $ cat hello.md
# 欢迎使用 mdfs

启动 HTTP 服务器

MARKDOWNFS_LISTEN=127.0.0.1:3000 cargo run --release --bin mdfs-server

服务器提供完整的 REST API，支持远程文件操作和版本管理。

MCP 集成（Cursor/Claude）

将 mdfs 添加到 MCP 客户端配置：

{
  "mcpServers": {
    "mdfs": {
      "command": "/path/to/mdfs-mcp",
      "env": {
        "MARKDOWNFS_DATA_DIR": "/path/to/data"
      }
    }
  }
}

配置后，AI Agent 可以直接在你的 Markdown 工作空间中创建、读取、搜索和版本控制文档。

适用场景

AI Agent 工作空间：为 Agent 提供持久化的 Markdown 记忆、可检查的产出物、搜索和回滚能力
团队知识库：多用户协作的 Markdown 文档管理，带权限控制和版本历史
个人笔记系统：结合 Git 式版本管理的本地笔记存储
应用后端：需要结构化 Markdown 存储的 Web 应用或工具

项目状态

markdownfs 是一个相对年轻的项目（2026 年 4 月创建），目前 189 个 Star，更新活跃。MIT 许可证允许自由使用和二次开发。项目文档完善，包含详细的用户管理、版本控制、HTTP API 和 MCP 集成指南。