使用说明

项目简介

这是一个名为 "FileSystem" 的 MCP 服务器，旨在为 LLM 客户端提供文件系统操作能力。通过一系列工具，LLM 可以浏览目录、读写文件、搜索内容、分析代码结构，甚至执行 Shell 命令，从而实现与本地文件系统的交互。

主要功能点

• 文件和目录操作: 提供常用的文件和目录管理功能，如列出目录内容 ('ls')、更改工作目录 ('cd')、读取文件内容 ('read_file')、写入文件 ('write_file')、创建目录 ('mkdir')、删除文件或目录 ('rm', 'rmdir')、复制 ('cp')、移动 ('mv') 等。
• 文件编辑与搜索: 支持对文件内容进行搜索和替换 ('edit_file')，以及使用正则表达式在文件中查找内容 ('grep')。
• 代码和文件分析: 能够分析 Python 和 Markdown 文件，提取关键信息，例如 Python 文件的函数和类，Markdown 文件的标题 ('summary')。
• 批量操作: 支持批量读取多个文件 ('read_files') 和批量生成文件摘要 ('summarize')。
• 项目导航: 提供 'work_on' 工具，方便 LLM 快速熟悉项目，包括切换到指定目录、列出目录内容并读取项目笔记文件 CLAUDE.md。
• 代码质量检查与格式化: 集成了 'ruff' 代码检查和格式化工具 ('ruff_check', 'ruff_format')，辅助 LLM 进行代码维护。
• Shell 命令执行: 允许 LLM 执行 Shell 命令 ('shell_command')，具有高灵活性但也需注意安全风险。

安装步骤

1. 克隆仓库:

   git clone https://github.com/kvas-it/mcp-server-fs
   cd mcp-server-fs
   

2. 创建并激活虚拟环境 (推荐):

   python3 -m venv .venv
   source .venv/bin/activate  # Linux / macOS
   .venv\Scripts\activate  # Windows
   

3. 安装依赖:

   pip install mcp-server
   pip install ruff  # 如果需要使用 ruff 相关工具
   

服务器配置

MCP 客户端需要配置以下 JSON 信息以连接到此 MCP 服务器：

{
  "server_name": "FileSystem",  // MCP 服务器名称，必须为 "FileSystem"
  "command": "python",         // 启动服务器的命令，通常为 python
  "args": ["server.py"]       // 命令参数，指定服务器脚本为 server.py
}

基本使用方法

1. 启动 MCP 服务器：在仓库根目录下，激活虚拟环境后，直接运行 'python server.py' 即可启动服务器。
2. 配置 MCP 客户端：将上述 JSON 配置信息填入 MCP 客户端的服务器配置中。
3. 通过 MCP 客户端与服务器交互：客户端可以向 "FileSystem" 服务器发送符合 MCP 协议的 JSON-RPC 请求，调用服务器提供的各种工具，例如 'ls', 'read_file', 'shell_command' 等，从而实现文件系统的操作和管理。具体工具的使用方法请参考工具的函数签名和文档注释。