文件系统 MCP 服务器使用说明

项目简介

Filesystem MCP Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务,旨在为 LLM 客户端提供标准化的文件系统访问和操作能力。它通过工具化的方式,使得 LLM 能够安全、可控地与本地文件系统进行交互,执行诸如文件读写、目录管理、文件分析、压缩解压以及文件监控等任务。

主要功能点

  • 文件和目录管理:支持创建、删除、复制、移动文件和目录,以及列出目录内容。
  • 文件内容操作:允许读取、写入和追加文件内容,支持指定编码格式。
  • 文件分析:提供文件类型检测、文本文件分析(行数、字数等)、哈希值计算以及查找重复文件等功能。
  • 压缩与解压:支持创建 ZIP 压缩包和解压 ZIP 文件。
  • 文件系统监控:可以监控指定目录的文件变化,并及时通知客户端。
  • 文件权限管理:支持获取和设置文件权限,以及设置文件为可执行。
  • 元数据管理:提供获取文件扩展元数据的功能,例如 MIME 类型、文件大小、创建时间等。
  • 流式操作:支持流式复制文件、分块写入文件以及流式转换文件内容,提高大文件处理效率。

安装步骤

  1. 克隆仓库

    git clone https://github.com/MCP-Mirror/bsmi021_mcp-filesystem-server
    cd bsmi021_mcp-filesystem-server
  2. 安装依赖

    npm install
  3. 构建服务器

    npm run build

服务器配置

MCP 服务器需要 MCP 客户端配置连接信息才能使用。在您的 MCP 客户端配置文件(通常是 'cline_mcp_settings.json')中,添加以下服务器配置:

{
  "mcpServers": {
    "filesystem": {  // 服务器名称,可以自定义
      "command": "node", // 启动服务器的命令
      "args": ["path/to/bsmi021_mcp-filesystem-server/build/index.js"] // 启动参数,指向构建后的服务器入口文件
    }
  }
}

请将 'path/to/bsmi021_mcp-filesystem-server' 替换为您实际克隆仓库的本地路径。

基本使用方法

配置完成后,您的 MCP 客户端即可连接到文件系统 MCP 服务器。通过客户端,您可以调用服务器提供的各种工具来执行文件系统操作。

例如,要列出 '/path/to/your/directory' 目录的内容,您可以调用 'list_directory' 工具,并传递 'path' 参数:

{
  "jsonrpc": "2.0",
  "method": "call_tool",
  "params": {
    "name": "list_directory",
    "arguments": {
      "path": "/path/to/your/directory"
    }
  },
  "id": 1
}

更多工具的使用方法和参数,请参考仓库中的 'README.md' 文件以及各个工具的定义。

信息

分类

数据库与文件