使用说明

项目简介

filesystem MCP server 是一个实现了 Model Context Protocol (MCP) 的服务器，旨在为 LLM 应用提供访问本地文件系统的能力。它通过标准化的 MCP 协议，允许 LLM 客户端安全、可控地与本地文件系统进行交互。

主要功能点

• 资源管理: 提供 "file://system" 资源，代表本地文件系统操作接口。
• 工具 (Tools): 实现了多种文件系统操作工具，包括：
  • 'read_file': 读取文件内容。
  • 'write_file': 写入文件内容。
  • 'create_directory': 创建目录。
  • 'list_directory': 列出目录内容。
  • 'move_file': 移动文件或目录。
  • 'search_files': 搜索文件。
  • 'get_file_info': 获取文件信息。
  • 'read_multiple_files': 读取多个文件内容。
  • 'list_allowed_directories': 列出允许访问的目录（功能待完善，目前返回固定文本）。

安装步骤

1. 安装 Python 环境: 确保已安装 Python 3.7 或更高版本。
2. 安装 uv: 根据仓库 'README.md' 建议，使用 'uv' 包管理器。 可以参考 README 的 "Development" -> "Building and Publishing" 部分，使用 'uv sync' 安装依赖。
3. 构建: 使用 'uv build' 构建项目。
4. 发布 (可选): 如果需要发布到 PyPI，可以使用 'uv publish'。（对于普通用户，通常无需发布，只需运行服务器）。

服务器配置

MCP 客户端需要配置 MCP 服务器的启动命令才能连接。以下是针对 Claude Desktop 客户端的配置示例 (参考仓库 'README.md' "Quickstart" 部分):

开发/未发布服务器配置:

"mcpServers": {
  "filesystem": {
    "command": "uv",
    "args": [
      "--directory",
      "/path/to/filesystem",  //  请替换为 filesystem 仓库的实际路径
      "run",
      "filesystem"
    ]
  }
}

已发布服务器配置:

"mcpServers": {
  "filesystem": {
    "command": "uvx",
    "args": [
      "filesystem"
    ]
  }
}

注意:

• 'server name' 为 'filesystem'。
• 'command' 和 'args' 需要根据实际部署环境和打包方式进行调整。 开发环境下，通常使用 'uv run filesystem' 在项目目录下直接运行。 发布环境下，可能使用 'uvx filesystem' 运行打包后的可执行文件。
• 请将 '/path/to/filesystem' 替换为实际的文件系统仓库路径。

基本使用方法

1. 启动服务器: 根据配置，在终端中运行相应的命令启动 filesystem MCP 服务器。例如，在项目根目录下运行 'uv run filesystem'。
2. 配置 MCP 客户端: 在 MCP 客户端 (如 Claude Desktop) 的配置文件中，添加上述服务器配置信息。
3. 在 MCP 客户端中使用: 在 MCP 客户端中，即可通过 'filesystem' 这个 server name 调用文件系统相关的工具，例如读取文件、写入文件等。 具体的工具调用方式请参考 MCP 客户端的文档。