MCP Filesystem

MCP Filesystem

site icon
2025.04.14 0
Go文件管理文件管理
MCP Filesystem 是一个基于 Model Context Protocol (MCP) 的服务,它能够将工作目录中的每个文件暴露为 MCP 资源,并发送文件变更通知。该服务支持 Gitignore 规则、文件变更检测、MIME 类型识别和编码处理等功能,适用于需要实时监控文件系统变化的场景。
View on GitHub

Overview

基本能力

产品定位

MCP Filesystem 是一个文件系统监控和管理工具,通过 MCP 协议提供文件资源的访问和变更通知服务。

核心功能

  • 资源管理:为工作区中的每个文件创建一个 MCP 资源
  • Gitignore 支持:遵循 .gitignore 规则
  • 变更通知:检测文件的变更、添加和删除
  • MIME 类型检测和编码处理:识别文件类型并处理各种文本编码

适用场景

  • 需要实时监控文件系统变化的开发环境
  • 需要将文件系统资源集成到 MCP 客户端的工作流程
  • 需要遵循 Gitignore 规则的文件管理场景

工具列表

  • info:获取文件信息
  • create:创建新文件
  • edit:编辑文件
  • delete:删除文件

常见问题解答

  • 如何启用调试日志:设置 DEBUG=1 环境变量
  • 如何配置工作区:在客户端配置中指定 --workspace 参数
  • 如何支持更多客户端:项目正在标准化 MCP 协议以兼容更多客户端

使用教程

使用依赖

  1. 安装 Go:按照 Go 官方安装指南 进行安装

安装教程

  1. 安装或更新服务:
go install github.com/isaacphi/mcp-filesystem@latest
  1. 配置客户端(以 Claude Desktop 为例):
{
  "mcpServers": {
    "filesystem": {
      "command": "mcp-filesystem",
      "args": ["--workspace", "/path/to/your/repository"]
    }
  }
}

调试方式

  1. 启用调试日志:
"env": {
  "DEBUG": "1"
}
  1. 查看日志输出以排查问题

许可证

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