Filesystem MCP Server 使用说明

项目简介

Filesystem MCP Server 是一个基于 Model Context Protocol (MCP) 构建的后端服务,旨在为 Claude 等 LLM 应用提供安全的文件系统访问能力。它允许 LLM 通过标准化的 MCP 协议,在预先设定的安全目录范围内执行文件读写、目录管理、文件搜索等操作。

主要功能点

  • 文件读写: 读取文件内容、写入文件内容、读取多个文件。
  • 目录管理: 创建目录、列出目录内容。
  • 文件操作: 移动文件、获取文件信息、搜索文件。
  • 安全控制: 仅允许访问预先指定的目录,保障文件系统安全。
  • 权限管理: 返回文件和目录的详细元数据,包括权限信息。
  • 允许目录列表: 列出服务器允许访问的所有目录。

安装步骤

  1. 克隆仓库到本地:
    git clone https://github.com/ai-yliu/filesystem-mcp-server.git
  2. 进入仓库目录:
    cd filesystem-mcp-server
  3. 安装依赖:
    npm install
  4. 构建项目:
    npm run build

服务器配置

在 MCP 客户端的配置文件中,添加以下服务器配置信息。请根据实际情况修改 'args' 中的允许访问目录。

{
  "mcpServers": {
    "filesystem-server": {
      "command": "node",
      "args": [
        "/path/to/filesystem-server/build/index.js",
        "/path/to/allowed/dir1",  // 请替换为允许访问的根目录1
        "/path/to/allowed/dir2"   // 请替换为允许访问的根目录2,可以添加更多
      ],
      "disabled": false,
      "autoApprove": []
    }
  }
}

参数说明:

  • 'command': 启动服务器的命令,这里使用 'node'。
  • 'args': 启动命令的参数,包括:
    • '/path/to/filesystem-server/build/index.js': 指向构建后的服务器入口文件路径,请替换为实际路径。
    • '/path/to/allowed/dir1', '/path/to/allowed/dir2', ...: 指定服务器允许访问的根目录。务必替换为实际的目录路径,LLM 客户端只能访问这些目录及其子目录下的文件。可以配置多个允许访问的根目录。

基本使用方法

  1. 启动 MCP 服务器:

    • 根据上面的服务器配置,修改 'args' 中的允许目录为你希望 LLM 访问的目录。
    • 在终端中,导航到 'filesystem-mcp-server' 仓库目录。
    • 运行配置中 'command' 和 'args' 组成的命令来启动服务器。例如,如果配置的允许目录为 '/data' 和 '/temp',则运行命令可能为:
    node build/index.js /data /temp
    • 服务器启动后,会在终端输出 "Filesystem MCP server running on stdio" 和 "Allowed directories: ..." 等信息。
  2. 在 MCP 客户端中使用:

    • 确保你的 MCP 客户端已正确配置了上面提供的服务器配置信息。
    • 在 LLM 应用中,通过 MCP 客户端调用 'filesystem-server' 提供的工具 (例如 'read_file', 'write_file', 'list_directory' 等) 来执行文件系统操作。客户端需要提供工具所需的参数,例如文件路径、目录路径等。
    • 服务器会根据请求执行相应的操作,并将结果返回给 MCP 客户端和 LLM 应用。

安全提示: 请务必仔细配置 'args' 中的允许访问目录,确保只允许 LLM 访问必要的目录,避免潜在的安全风险。

信息

分类

数据库与文件