MCP File System Server

MCP File System Server

site icon
2025.04.19 0
Python文件管理文件管理
MCP File System Server 是一个基于 Model Context Protocol (MCP) 的简单文件系统操作服务器,提供了一套清晰的 API 用于在指定项目目录内执行文件系统操作。该服务器允许 AI 助手(如 Claude)或其他兼容 MCP 的系统与本地文件系统进行交互,实现读取、写入、更新、删除文件等功能,同时确保所有操作都限制在指定的项目目录内,保障安全性。
View on GitHub

Overview

基本能力

产品定位

MCP File System Server 是一个文件系统操作服务器,旨在通过 MCP 协议为 AI 助手提供本地文件系统的交互能力,支持开发者在项目中进行文件管理。

核心功能

  • list_directory: 列出项目目录中的所有文件和目录
  • read_file: 读取文件内容
  • save_file: 原子性地写入文件内容
  • append_file: 在文件末尾追加内容
  • delete_this_file: 删除指定文件
  • edit_file: 使用高级模式匹配进行选择性编辑
  • Structured Logging: 提供全面的日志系统,支持人类可读和 JSON 格式

适用场景

  • AI 助手与本地文件系统的交互
  • 代码生成、修改和组织
  • 项目文件管理和调试
  • 自动化文件操作

工具列表

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

常见问题解答

  • 如何确保文件操作的安全性? 所有文件操作都限制在指定的项目目录内,防止路径遍历攻击。
  • 如何调试服务器? 可以使用 MCP Inspector 进行调试和测试。
  • 如何集成到 VSCode 或 Claude Desktop? 参考文档中的配置步骤,修改相应的配置文件。

使用教程

使用依赖

  1. 确保已安装 Python 和 Git。
  2. 创建并激活虚拟环境(推荐): bash python -m venv venv source venv/bin/activate # Windows: venv\Scripts\activate

安装教程

  1. 克隆仓库: bash git clone https://github.com/MarcusJellinghaus/mcp_server_filesystem.git cd mcp-server-filesystem
  2. 安装依赖: bash pip install -e .

调试方式

  1. 启动服务器: bash python -m src.main --project-dir /path/to/project [--log-level LEVEL] [--log-file PATH]
  2. 使用 MCP Inspector 调试: bash npx @modelcontextprotocol/inspector uv --directory C:\path\to\mcp_server_filesystem run src\main.py
  3. 在 MCP Inspector 的 Web UI 中配置 Python 解释器和参数。

许可证

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