MCP File Server

MCP File Server

一个安全的文件系统操作模型上下文协议(MCP)服务器。它使像 Claude 和 Cursor 这样的 AI 助手能够访问、读取、写入和管理你系统上的文件,并具有强大的路径验证和动态存储位置管理功能。

Priyonuj

开发者工具
访问服务器

README

MCP 文件服务器

一个使用模型上下文协议 (MCP) 的安全文件服务器实现,为文件系统操作提供标准化接口。

概述

MCP 文件服务器是一个 Node.js 应用程序,它实现了一个专门用于文件操作的 MCP 服务器。它提供了一种安全且标准化的方式,通过 MCP 协议与文件系统进行交互,适用于与 Claude 等 AI 助手以及 Cursor 等开发者工具集成。

该服务器提供以下工具:

文件操作

  • list_files: 列出指定目录中的文件
  • read_file: 读取文件的内容
  • write_file: 将内容写入文件
  • delete_file: 删除文件或目录
  • set_base_directory: 直接从聊天中设置文件操作的基本目录
  • get_base_directory: 获取当前基本目录

Git 操作

  • git_command: 在基本目录中执行 git 命令

项目结构

该项目遵循模块化架构,服务按职责组织:

mcp-file-server/
├── services/               # 服务模块
│   ├── configService.js    # 配置管理
│   ├── fileService.js      # 文件系统操作
│   ├── gitService.js       # Git 操作
│   ├── loggerService.js    # 日志功能
│   └── toolService.js      # MCP 工具注册
├── files/                  # 默认存储目录
├── log/                    # 日志文件
├── examples/               # 示例脚本和用法演示
├── mcp_server.js           # 主应用程序入口点
├── package.json            # 项目元数据和依赖项
└── README.md               # 文档

安全特性

  • 强大的路径验证,防止目录遍历攻击
  • 仔细的文件路径规范化和解析
  • 命令验证,防止命令注入
  • 操作记录到专用日志文件中,以便审计
  • 安全处理相对路径

前提条件

  • Node.js >= 16.0.0
  • npm 或 yarn 包管理器
  • Git(用于 git_command 功能)

安装

  1. 克隆此存储库:

    git clone <repository-url>
    cd mcp-file-server
    
  2. 安装依赖项:

    npm install
    

配置

环境变量

  • BASE_DIRECTORY: (可选) 文件操作的基本目录的路径。如果未指定,则默认为项目根目录中的 files 目录。

目录结构

  • /files: 文件操作的默认基本目录
  • /log: 包含调试日志文件

用法

启动服务器

npm start

用于开发并自动重新加载:

npm run dev

服务器将运行并连接到标准输入/输出进行通信。

从聊天中设置基本目录

此实现的一个关键特性是能够直接从聊天界面设置基本目录。这意味着您无需重新启动服务器或修改配置文件即可更改文件的存储和访问位置。

只需让 AI 助手设置基本目录,例如:

  • "将基本目录设置为 C:/Users/username/Documents"
  • "将文件存储位置更改为 /home/user/data"

助手将使用 set_base_directory 工具来更新位置。您可以随时通过询问当前基本目录来验证当前位置。

使用 Git 命令

服务器允许您直接从聊天界面执行 Git 命令。只需让 AI 助手运行 git 命令,例如:

  • "运行 git status"
  • "执行 git log --oneline"
  • "使用 git checkout -b feature/new-feature 创建一个新分支"

您还可以指定要使用的 shell:

  • "使用 PowerShell,运行 git status"
  • "在 bash 中,执行 git diff"
  • "使用 cmd,运行 git pull origin main"

配置对象示例

以下是将 MCP 文件服务器与 Claude Desktop 或 Cursor 集成的配置对象示例:

{
  "mcpServers": {
    "file-server": {
      "command": "node",
      "args": ["/path/to/mcp-file-server/mcp_server.js"],
      "disabled": false,
      "autoApprove": ["list_files", "read_file", "write_file", "delete_file", "set_base_directory", "get_base_directory", "git_command"]
    }
  }
}

配置属性说明:

  • mcpServers: 所有 MCP 服务器配置的容器
  • file-server: 此特定 MCP 服务器的唯一标识符
  • command: 要执行的命令(在本例中,node 用于运行 JavaScript 文件)
  • args: 传递给命令的参数数组(服务器脚本的路径)
  • disabled: 此服务器当前是否禁用(false = 启用)
  • autoApprove: 应该自动批准而无需用户确认的工具列表

扩展服务器

模块化架构使扩展服务器的新功能变得容易:

  1. services/ 目录中创建一个新服务
  2. 将您的服务的注册添加到 toolService.js 文件
  3. 更新主 mcp_server.js 文件以初始化您的服务

例如,要添加新的压缩服务:

  • 创建 services/compressionService.js
  • registerCompressionTools() 方法添加到 toolService.js
  • 更新主服务器以初始化您的压缩服务

API 参考

set_base_directory

设置文件操作的新基本目录。

参数:

  • path: 新基本目录的绝对路径

返回值:

  • 确认消息

get_base_directory

获取当前基本目录路径。

参数:

返回值:

  • 当前基本目录路径

list_files

列出指定目录中的文件。

参数:

  • directory: (可选) 要列出的目录路径(默认为根目录)

返回值:

  • 格式化的文件和目录列表

read_file

读取文件的内容。

参数:

  • path: 要读取的文件的路径

返回值:

  • 文件的内容

write_file

将内容写入文件。

参数:

  • path: 要写入的文件的路径
  • content: 要写入文件的内容

返回值:

  • 确认消息

delete_file

删除文件或目录。

参数:

  • path: 要删除的文件或目录的路径

返回值:

  • 确认消息

git_command

在基本目录中执行 git 命令。

参数:

  • command: 要执行的 Git 命令(不带 'git' 前缀)
  • shell: (可选) 用于执行的 Shell (cmd, powershell, bash)

返回值:

  • 命令输出(stdout 和 stderr)

故障排除

检查 log/mcp_debug.log 中的日志文件,以获取有关服务器操作的详细信息以及可能发生的任何错误。

常见问题:

  1. 路径访问错误:确保 BASE_DIRECTORY 设置为进程有权访问的位置。
  2. 连接被拒绝:在尝试连接之前,请确保服务器正在运行。
  3. 找不到工具:验证配置中的工具名称是否与服务器中定义的工具名称完全匹配。
  4. 端口冲突:如果您运行多个 MCP 服务器,请确保它们使用不同的端口。
  5. 无效的基本目录:从聊天中设置基本目录时,请确保提供绝对路径(而不是相对路径)。
  6. Git 命令错误:使用 git 命令时,请确保已安装 Git 并且基本目录是有效的 Git 存储库。

贡献

我们欢迎您为改进 MCP 文件服务器做出贡献!以下是您可以提供帮助的方式:

贡献方式

  • 错误报告:提交详细的错误报告,并提供重现步骤
  • 功能请求:建议新功能或改进
  • 文档:帮助改进或扩展文档
  • 代码贡献:提交包含错误修复或新功能的拉取请求

开发流程

  1. Fork 存储库:创建您自己的项目 fork
  2. 创建分支:在新分支中进行更改
  3. 遵循编码标准:保持现有的代码风格
  4. 编写测试:为新功能或错误修复添加测试
  5. 文档:更新文档以反映您的更改
  6. 提交拉取请求:打开一个 PR,其中包含对更改的清晰描述

拉取请求指南

  • 保持 PR 专注于单个功能或错误修复
  • 包含对更改内容和原因的清晰描述
  • 确保所有测试都通过
  • 更新相关文档

报告问题

报告问题时,请包括:

  • 对问题的清晰描述
  • 重现问题的步骤
  • 预期行为与实际行为
  • 环境详细信息(操作系统、Node.js 版本等)

推荐服务器

Playwright MCP Server

Playwright MCP Server

一个模型上下文协议服务器,它使大型语言模型能够通过结构化的可访问性快照与网页进行交互,而无需视觉模型或屏幕截图。

官方
精选
TypeScript
Magic Component Platform (MCP)

Magic Component Platform (MCP)

一个由人工智能驱动的工具,可以从自然语言描述生成现代化的用户界面组件,并与流行的集成开发环境(IDE)集成,从而简化用户界面开发流程。

官方
精选
本地
TypeScript
MCP Package Docs Server

MCP Package Docs Server

促进大型语言模型高效访问和获取 Go、Python 和 NPM 包的结构化文档,通过多语言支持和性能优化来增强软件开发。

精选
本地
TypeScript
Claude Code MCP

Claude Code MCP

一个实现了 Claude Code 作为模型上下文协议(Model Context Protocol, MCP)服务器的方案,它可以通过标准化的 MCP 接口来使用 Claude 的软件工程能力(代码生成、编辑、审查和文件操作)。

精选
本地
JavaScript
@kazuph/mcp-taskmanager

@kazuph/mcp-taskmanager

用于任务管理的模型上下文协议服务器。它允许 Claude Desktop(或任何 MCP 客户端)在基于队列的系统中管理和执行任务。

精选
本地
JavaScript
mermaid-mcp-server

mermaid-mcp-server

一个模型上下文协议 (MCP) 服务器,用于将 Mermaid 图表转换为 PNG 图像。

精选
JavaScript
Jira-Context-MCP

Jira-Context-MCP

MCP 服务器向 AI 编码助手(如 Cursor)提供 Jira 工单信息。

精选
TypeScript
Linear MCP Server

Linear MCP Server

一个模型上下文协议(Model Context Protocol)服务器,它与 Linear 的问题跟踪系统集成,允许大型语言模型(LLM)通过自然语言交互来创建、更新、搜索和评论 Linear 问题。

精选
JavaScript
Sequential Thinking MCP Server

Sequential Thinking MCP Server

这个服务器通过将复杂问题分解为顺序步骤来促进结构化的问题解决,支持修订,并通过完整的 MCP 集成来实现多条解决方案路径。

精选
Python
Curri MCP Server

Curri MCP Server

通过管理文本笔记、提供笔记创建工具以及使用结构化提示生成摘要,从而实现与 Curri API 的交互。

官方
本地
JavaScript