MCP File System Server

MCP File System Server

site icon
2025.04.09 7
Python文件系统操作AI 协作代码管理文件管理开发效率
MCP File System Server 是一个基于 Model Context Protocol (MCP) 的服务器,提供文件系统操作功能。它允许 AI 助手(如 Claude)或其他兼容 MCP 的系统与本地文件系统进行交互,实现读取、写入、修改和删除文件等操作。所有操作都限制在指定的项目目录内,确保安全性。
View on GitHub

Overview

基本能力

产品定位

MCP File System Server 是一个文件系统操作服务器,旨在为 AI 助手提供对本地文件系统的安全访问能力,支持开发者在项目中进行高效的代码管理和协作。

核心功能

  • list_directory: 列出项目目录中的文件和目录
  • read_file: 读取文件内容
  • save_file: 原子性地写入文件内容
  • append_file: 追加内容到文件末尾
  • delete_this_file: 删除指定文件
  • edit_file: 使用模式匹配进行选择性编辑
  • 结构化日志记录:支持人类可读和 JSON 格式的日志

适用场景

  • AI 助手协助代码生成和修改
  • 项目文件管理和组织
  • 代码调试和修复
  • 自动化文件操作

工具列表

工具名称 描述
list_directory 列出项目目录中的文件和目录
read_file 读取文件内容
save_file 创建或覆盖文件
append_file 追加内容到现有文件
delete_this_file 删除文件
edit_file 使用模式匹配进行选择性编辑

常见问题解答

  • 如何确保文件操作的安全性? 所有路径都经过规范化验证,确保不超出项目目录范围。
  • 如何集成到 VSCode? 需要配置 Cline 扩展的 MCP 服务器设置文件。
  • 如何调试服务器? 可以使用 MCP Inspector 工具进行调试。

使用教程

使用依赖

  1. 确保已安装 Python 和 Git
  2. 创建并激活虚拟环境(推荐)

安装教程

# 克隆仓库
git clone https://github.com/MarcusJellinghaus/mcp_server_filesystem.git
cd mcp-server-filesystem

# 创建并激活虚拟环境
python -m venv venv
source venv/bin/activate  # Windows: venv\Scripts\activate

# 安装依赖
pip install -e .

调试方式

# 运行服务器
python -m src.main --project-dir /path/to/project --log-level DEBUG

# 使用 MCP Inspector 调试
npx @modelcontextprotocol/inspector uv --directory C:\path\to\mcp_server_filesystem run src\main.py

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。