ai-yliu_filesystem-mcp-server

🚀 文件系统 MCP 服务器

本项目是为 Claude AI 提供文件系统操作的一个模型上下文协议 (MCP) 服务器，它能让 Claude AI 对文件系统进行多样化操作，提升使用灵活性。

🚀 快速开始

要快速使用此文件系统 MCP 服务器，可按以下步骤操作：

1. 克隆此仓库。
2. 安装依赖项: npm install。
3. 构建项目: npm run build。
4. 使用以下命令运行服务器：

node build/index.js /path/to/allowed/dir1 /path/to/allowed/dir2

5. 将此服务器添加到您的 MCP 配置文件中：

{
  "mcpServers": {
    "filesystem-server": {
      "command": "node",
      "args": [
        "/path/to/filesystem-server/build/index.js",
        "/path/to/allowed/dir1",
        "/path/to/allowed/dir2"
      ],
      "disabled": false,
      "autoApprove": []
    }
  }
}

✨ 主要特性

此 MCP 服务器提供了以下丰富的文件系统操作：

1. read_file：读取文件的全部内容。
   • 输入：path（字符串）。
   • 使用 UTF-8 编码读取完整文件内容。
2. read_multiple_files：同时读取多个文件。
   • 输入：paths（字符串[]）。
   • 读取失败不会阻止整个操作继续。
3. write_file：创建新文件或覆盖现有文件。
   • 输入：
     • path（字符串）：文件位置。
     • content（字符串）：文件内容。
4. create_directory：创建新目录或确保目录存在。
   • 输入：path（字符串）。
   • 如果需要，创建父目录。
   • 目录已存在时会静默成功。
5. list_directory：列出目录内容并带有 [FILE] 或 [DIR] 前缀。
   • 输入：path（字符串）。
6. move_file：移动或重命名文件和目录。
   • 输入：
     • source（字符串）。
     • destination（字符串）。
   • 如果目标已存在则操作失败。
7. search_files：递归搜索文件/目录。
   • 输入：
     • path（字符串）：起始目录。
     • pattern（字符串）：搜索模式。
   • 案例不敏感匹配。
   • 返回完整路径的匹配项。
8. get_file_info：获取文件/目录的详细元数据。
   • 输入：path（字符串）。
   • 返回：
     • 大小。
     • 创建时间。
     • 修改时间。
     • 访问时间。
     • 类型（文件/目录）。
     • 权限。
9. list_allowed_directories：列出服务器允许访问的所有目录。
   • 无需输入。
   • 返回此服务器可以读写访问的目录。

🔧 技术细节

服务器仅允许在通过命令行参数指定的目录内执行操作，这一机制保障了服务器操作的安全性，避免了对非授权目录的访问。

📦 安装指南

1. 克隆此仓库。
2. 安装依赖项: npm install。
3. 构建项目: npm run build。

💻 使用示例

基础用法

运行服务器的基础命令如下：

node build/index.js /path/to/allowed/dir1 /path/to/allowed/dir2

高级用法

将服务器添加到 MCP 配置文件中，可实现更灵活的配置：

{
  "mcpServers": {
    "filesystem-server": {
      "command": "node",
      "args": [
        "/path/to/filesystem-server/build/index.js",
        "/path/to/allowed/dir1",
        "/path/to/allowed/dir2"
      ],
      "disabled": false,
      "autoApprove": []
    }
  }
}

📄 许可证

本项目采用 ISC 许可证。