
Filesystem MCP Server

2024.12.19
2
TypeScript文件系统操作文件分析压缩解压文件管理
mcp-filesystem-server 是一个基于 Model Context Protocol (MCP) 的服务实现,提供文件系统操作、分析和处理能力。它通过标准化的工具接口,支持目录操作、文件操作、分析操作和压缩操作等多种功能。该服务适用于需要进行文件系统管理和分析的各种场景。
View on GitHub
Overview
基本能力
产品定位
mcp-filesystem-server 是一个专注于文件系统操作和管理的 MCP 服务,提供了一系列工具来支持文件的读写、目录管理、文件分析和压缩解压等功能。
核心功能
- 目录操作:包括列出目录内容、创建目录等。
- 文件操作:包括读取文件、写入文件、追加文件内容等。
- 分析操作:包括分析文本文件属性、计算文件哈希值、查找重复文件等。
- 压缩操作:包括创建 ZIP 压缩文件和提取 ZIP 压缩文件。
适用场景
- 文件管理系统:用于管理和操作文件系统中的文件和目录。
- 数据分析:用于分析文件内容,如统计行数、单词数等。
- 文件备份与恢复:通过压缩和解压功能实现文件的备份和恢复。
- 重复文件检测:用于查找和清理重复文件。
工具列表
- list_directory:列出目录内容及其元数据。
- create_directory:创建新目录。
- read_file:读取文件内容。
- write_file:写入内容到文件。
- append_file:追加内容到文件。
- analyze_text:分析文本文件属性。
- calculate_hash:计算文件哈希值。
- find_duplicates:查找重复文件。
- create_zip:创建 ZIP 压缩文件。
- extract_zip:提取 ZIP 压缩文件。
常见问题解答
- 错误处理:服务使用标准 MCP 错误代码,包括解析错误、无效请求、方法未找到等。
- 开发模式:支持开发模式下的代码监视和自动重启。
- 测试与质量:提供测试套件和代码质量检查工具。
使用教程
使用依赖
- 确保已安装 Node.js 和 npm。
- 安装项目依赖:
npm install
安装教程
- 克隆仓库:
git clone <repository-url>
cd filesystem-server
- 安装依赖:
npm install
- 构建服务:
npm run build
- 配置 MCP 设置(cline_mcp_settings.json):
{
"mcpServers": {
"filesystem": {
"command": "node",
"args": ["path/to/filesystem-server/build/index.js"]
}
}
}
调试方式
- 运行测试套件:
npm test
- 运行带覆盖率的测试:
npm run test:coverage
- 开发模式下运行:
npm run watch
- 代码质量检查:
npm run lint
npm run type-check