关键词

文件访问文件系统目录浏览内容检索资源管理

项目简介

Filesys MCP服务器是一个轻量级的MCP（Model Context Protocol）服务器，它允许LLM客户端通过标准化的MCP协议安全地访问服务器上预配置目录中的文件。该服务器通过资源（Resources）的形式暴露文件系统操作能力，例如列出文件和读取文件内容。

主要功能点

  • 文件列表: 允许客户端获取服务器指定目录下的文件列表。
  • 文件读取: 允许客户端读取指定文件的内容和元数据（如大小和修改时间）。
  • 安全性: 通过路径验证和目录遍历保护机制，确保只能访问预配置目录下的文件，防止非法文件访问。
  • 易于配置: 通过JSON配置文件轻松设置服务器访问的根目录。

安装步骤

  1. 克隆仓库: 
    git clone https://github.com/iBz-04/Filesys.git
  2. 进入项目目录: 
    cd Filesys
  3. 创建虚拟环境 (可选): 
    python -m venv venv
source venv/bin/activate  # Linux/macOS
# venv\Scripts\activate  # Windows
  4. 安装依赖: 
    pip install -r requirements.txt

服务器配置

MCP客户端需要配置以下信息以连接到Filesys MCP服务器。这是一个JSON格式的配置示例，通常在MCP客户端的设置中填写：

{
  "serverName": "FilesysServer",
  "command": "python",
  "args": ["run.py"],
  "description": "Filesys MCP Server for file access"
}

配置参数说明:

  • 'serverName': 服务器的名称，可以自定义。
  • 'command': 启动服务器的命令，这里使用 'python' 解释器。
  • 'args': 传递给 'python' 命令的参数，'run.py' 是服务器启动脚本。 请确保在 Filesys 项目的根目录下运行此命令。
  • 'description': 服务器的描述信息，可以自定义。

基本使用方法

  1. 启动服务器: 在项目根目录下，运行以下命令启动 Filesys MCP 服务器：

    python run.py

    服务器启动后，会监听MCP客户端的请求。

  2. 使用MCP客户端: 使用任何兼容MCP协议的客户端，配置上述服务器配置信息，即可连接到 Filesys MCP 服务器。

    • 列出文件: 客户端向服务器发送请求 'files://list' 可以获取文件列表。
    • 读取文件: 客户端向服务器发送请求 'files://read/{filename}' (将 '{filename}' 替换为实际文件名) 可以读取文件内容和元数据。

    仓库中提供了 'example_client.py' 作为示例客户端，可以参考其用法进行测试和开发。

信息

分类

数据库与文件

访问项目