使用说明

项目简介

本项目实现了一个基于文件系统的MCP服务器,旨在为LLM(大型语言模型)客户端提供文件操作能力。该服务器允许LLM客户端在预先配置的安全目录下进行文件和目录的创建、读取、修改和列表等操作,从而扩展LLM与外部环境的交互能力。

主要功能点

  • 目录列表: 允许LLM客户端获取指定目录下的文件和子目录列表。
  • 创建目录: 允许LLM客户端在安全目录内创建新的目录。
  • 创建文件: 允许LLM客户端在安全目录内创建新的文件。
  • 修改文件: 允许LLM客户端修改安全目录内的文件内容。
  • 安全限制: 所有文件操作都被限制在预先配置的根目录内,确保操作的安全性,防止LLM客户端访问或修改未授权的文件系统区域。

安装步骤

  1. 安装Python包: 确保你的Python环境中安装了 'mcp' 包。如果未安装,请打开终端或命令提示符并执行以下命令:
    pip install mcp

服务器配置

MCP客户端需要配置服务器连接信息才能与此文件系统MCP服务器通信。以下是一个JSON格式的配置示例,你需要将其提供给你的MCP客户端。请注意,这里的配置信息是静态的,你需要根据实际情况进行调整。

{
  "serverName": "filesystem-server",  // 服务器名称,可以自定义,用于在客户端标识该服务器
  "command": "python",               // 启动服务器的命令,这里使用 python 解释器
  "args": [                           // 启动服务器命令的参数列表
    "MCP Servers/filesystems/server.py" // 服务器脚本的路径,相对于你的工作目录或MCP客户端的配置
  ],
  "transport": "stdio",              // (可选) 传输协议,默认为 stdio,如果服务器支持其他协议,可以在这里配置,例如 "websocket" 或 "sse"
  "capabilities": [                  // (可选) 服务器能力声明,如果服务器声明了特定的能力,可以在这里列出,例如 "resources", "tools", "prompts"
    "resources",
    "tools"
  ],
  "configuration": {                 // (可选) 服务器特定的配置参数,例如文件系统服务器的根目录
    "base_dir": "/path/to/your/safe/directory" // 文件系统操作的根目录,请替换为实际的安全目录路径
  }
}

基本使用方法

  1. 启动服务器: 在安装并配置完成后,MCP客户端会根据你提供的配置信息启动文件系统服务器。通常情况下,你无需手动启动服务器,MCP客户端会自动处理。

  2. 客户端交互: LLM客户端会通过MCP协议与文件系统服务器进行通信,发送JSON-RPC请求以执行文件操作,例如列出目录、读取文件等。具体的请求格式和操作方式取决于MCP客户端的实现和提供的接口。请参考你的MCP客户端文档来了解如何使用文件系统服务器提供的功能。

请注意: 你需要将配置信息中的 '"MCP Servers/filesystems/server.py"' 替换为服务器脚本的实际路径,并根据你的需求修改 '"base_dir"' 为合适的安全目录。 确保LLM客户端能够访问到你配置的服务器脚本和安全目录。

信息

分类

数据库与文件