Filesystem MCP Server

Filesystem MCP Server

site icon
2024.12.27 0
TypeScript文件系统操作文件分析文件压缩文件管理
Filesystem MCP Server 是一个基于 Model Context Protocol (MCP) 的服务实现,提供文件系统操作、分析和处理能力。它通过标准化的工具接口,支持目录操作、文件操作、分析操作和压缩操作等多种功能。该服务适用于需要进行文件系统管理和分析的场景,如自动化文件处理、数据分析和文件压缩等。
View on GitHub

Overview

基本能力

产品定位

Filesystem MCP Server 是一个专注于文件系统操作和分析的服务,提供标准化的工具接口,支持多种文件系统操作。

核心功能

  1. 目录操作:包括列出目录内容、创建目录等。
  2. 文件操作:包括读取文件、写入文件、追加文件内容等。
  3. 分析操作:包括分析文本文件属性、计算文件哈希值、查找重复文件等。
  4. 压缩操作:包括创建 ZIP 压缩包和解压 ZIP 文件。

适用场景

  1. 自动化文件处理:如批量读取、写入或修改文件。
  2. 数据分析:如分析文件内容、计算文件哈希值等。
  3. 文件压缩与解压:如创建或解压 ZIP 文件。

工具列表

  1. list_directory:列出目录内容及其元数据。
  2. create_directory:创建新目录。
  3. read_file:读取文件内容。
  4. write_file:写入文件内容。
  5. append_file:追加文件内容。
  6. analyze_text:分析文本文件属性。
  7. calculate_hash:计算文件哈希值。
  8. find_duplicates:查找重复文件。
  9. create_zip:创建 ZIP 压缩包。
  10. extract_zip:解压 ZIP 文件。

常见问题解答

  1. 错误处理:服务使用标准 MCP 错误代码,如 ParseErrorInvalidRequest 等。
  2. 错误响应:包括错误代码、错误消息和上下文信息。

使用教程

使用依赖

  1. 确保已安装 Node.js 和 npm。
  2. 克隆仓库并安装依赖:
git clone <repository-url>
cd filesystem-server
npm install

安装教程

  1. 构建服务:
npm run build
  1. 配置 MCP 设置(cline_mcp_settings.json):
{
  "mcpServers": {
    "filesystem": {
      "command": "node",
      "args": ["path/to/filesystem-server/build/index.js"]
    }
  }
}

调试方式

  1. 运行测试:
npm test
  1. 运行覆盖率测试:
npm run test:coverage
  1. 开发模式(监听文件变化):
npm run watch
  1. 代码质量检查:
npm run lint
npm run type-check

许可证

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