项目简介

Filesys 是一个基于 Model Context Protocol (MCP) 构建的文件系统服务器，旨在为 LLM (大型语言模型) 提供安全、便捷的本地文件访问能力。通过 Filesys，LLM 客户端可以像操作远程资源一样，以标准化的方式读取和管理服务器所在机器上的文件。

主要功能点

• 文件列表：允许 LLM 获取服务器指定目录下的文件列表，方便 LLM 理解可访问的文件资源。
• 文件内容读取：支持 LLM 读取指定文件的内容，使 LLM 能够获取文件中的信息。
• 安全性：通过配置限制 LLM 访问的文件目录，并防止目录遍历等安全风险，保障本地文件系统的安全。
• 易于使用：使用 Python 开发，配置简单，易于部署和运行。
• MCP 标准协议：遵循 MCP 协议，可以与任何兼容 MCP 协议的 LLM 客户端进行交互。

安装步骤

1. 下载 Filesys： 点击 Download Filesys 链接，下载最新的 Filesys 服务器程序压缩包。您也可以访问仓库的 "Releases" 页面，选择其他版本下载。

2. 解压文件： 将下载的压缩包解压到您希望运行 Filesys 服务器的目录。

3. 准备配置文件： 在解压后的 'config' 目录下，您会找到 'config.json' 文件。请根据您的需求编辑此文件。

   {
     "directory": "path/to/your/directory"
   }
   

   将 '"path/to/your/directory"' 替换为您希望 LLM 可以访问的本地目录的路径。例如，如果您想让 LLM 访问用户主目录下的 'documents' 文件夹，可以设置为 '"directory": "~/documents"'。请务必仔细配置此项，限制 LLM 的文件访问范围，保障安全。

4. 运行服务器： 打开终端或命令提示符，进入解压后的 Filesys 目录。 运行命令 'python run.py' 启动 Filesys 服务器。服务器默认使用 Stdio 协议与客户端通信。

服务器配置

MCP 客户端需要配置以下信息才能连接到 Filesys 服务器。以下是 JSON 格式的配置信息示例，包含了启动 Filesys 服务器所需的命令和参数。

{
  "serverName": "FilesysServer",  // 服务器名称，可以自定义
  "command": "python",          // 启动服务器的命令，这里使用 python
  "args": ["run.py"]           // 启动服务器命令的参数，指定运行 run.py 文件
}

配置说明:

• 'serverName': MCP 服务器的名称，客户端可以使用此名称来标识服务器。可以根据需要自定义。
• 'command': 运行服务器程序的可执行命令。Filesys 服务器使用 Python 编写，因此这里设置为 'python'，确保您的运行环境中已安装 Python。
• 'args': 传递给 'command' 的参数列表。Filesys 服务器的启动脚本是 'run.py'，所以这里设置为 '["run.py"]'。

重要提示: MCP 客户端需要根据自身的功能和配置方式，正确填写以上配置信息，才能成功连接并使用 Filesys 服务器提供的文件系统访问服务。请参考您的 MCP 客户端的使用文档进行配置。

基本使用方法

1. 启动 Filesys 服务器：按照上述安装步骤启动 Filesys 服务器。

2. 配置 MCP 客户端：在您的 LLM 应用或 MCP 客户端中，配置连接 Filesys 服务器所需的信息，包括服务器启动命令等（参考上述“服务器配置”部分）。

3. 通过客户端与服务器交互：

   • 列出文件：客户端可以向服务器发送请求，获取配置目录下的文件列表。例如，使用 'files://list' 资源 URI。
   • 读取文件内容：客户端可以请求读取指定文件的内容。例如，使用 'files://read/文件名' 资源 URI，将 '文件名' 替换为要读取的文件名。

   具体的操作方式和请求格式，请参考您的 MCP 客户端的文档和 Filesys 服务器提供的资源定义。'example_client.py' 文件提供了一个简单的客户端示例，可以帮助您理解如何与 Filesys 服务器进行交互。