首页/文件系统/filesystem-mcp

filesystem-mcp

查看源码
2025-5-11
Words 829Read Time 3 min
Score:85

提供安全的相对文件系统访问的Node.js MCP服务器,专为AI代理如Cline和Claude设计。

文件系统 MCP 🌐

https://img.shields.io/github/v/release/Tabeeh/filesystem-mcp?style=flat-square
https://img.shields.io/badge/Node.js-v16.0.0-brightgreen
欢迎来到 Filesystem MCP 仓库!该项目提供了一个基于 Node.js 的模型上下文协议(Model Context Protocol, MCP)服务器,旨在为 Cline 和 Claude 等 AI 代理提供安全的相对文件系统访问。

目录

  • 功能
  • 安装
  • 使用
  • API 文档
  • 贡献
  • 许可证
  • 联系

功能 ✨

  • 安全访问:确保 AI 代理以安全的方式与文件系统交互。
  • 相对路径:简化文件访问过程,无需使用绝对路径。
  • 支持 AI 代理:专为 Cline 和 Claude 设计。
  • 基于 Node.js:利用 Node.js 的强大功能进行高效的服务器端操作。
  • TypeScript 支持:提供类型安全和更好的开发体验。

安装 ⚙️

要开始使用 Filesystem MCP 服务器,请按照以下简单步骤操作:
  1. 克隆仓库
    1. 安装依赖: 确保已安装 Node.js,然后运行:
      1. 下载最新版本: 您可以在这里找到最新版本。下载适当的文件并执行它。

      使用 🚀

      要启动服务器,请运行以下命令:

      示例配置

      您可以通过修改 config.json 文件来配置服务器。以下是一个示例配置:

      发起请求

      服务器运行后,您可以发起请求以访问文件系统。以下是使用 curl 的示例:

      错误处理

      服务器会为各种错误场景返回适当的 HTTP 状态码和消息。例如:
      • 404 Not Found:请求的文件不存在。
      • 403 Forbidden:访问文件被拒绝。

      API 文档 📚

      Filesystem MCP 服务器提供了一个简单的 API 用于与文件系统交互。以下是主要端点:

      GET /files/{path}

      获取指定相对路径的文件内容。
      • 参数
        • path:文件的相对路径。
      • 响应
        • 200 OK:返回文件内容。
        • 404 Not Found:文件不存在。
        • 403 Forbidden:访问被拒绝。

      POST /files/{path}

      在指定相对路径创建或更新文件。
      • 参数
        • path:文件的相对路径。
      • 请求体
        • content:要写入文件的内容。
      • 响应
        • 201 Created:文件创建成功。
        • 400 Bad Request:无效请求。

      贡献 🤝

      我们欢迎贡献!如果您想帮助改进 Filesystem MCP,请按照以下步骤操作:
      1. Fork 仓库。
      1. 创建一个新分支:
        1. 进行更改。
        1. 提交更改:
          1. 推送到分支:
            1. 打开一个 Pull Request。

            许可证 📜

            该项目采用 MIT 许可证。详情请参阅 LICENSE 文件。

            联系 📫

            如有任何问题或反馈,请随时联系:
            有关最新更新、发布和文档,请访问我们的发布部分。
            祝您编码愉快!🎉
            上一篇
            awsome_kali_MCPServers
            下一篇
            mcp-for-security