shield_lock
JinDaGe
← Back to MCP directory
publicPublicdnsLocal runtime

MCP File System

一个基于MCP协议的文件系统服务，提供标准化接口的文件和目录操作。

article

README

🚀 MCP 文件系统

MCP 文件系统是一个基于 Model Context Protocol (MCP) 的服务器，它提供了标准接口，可用于执行各类文件系统操作，极大地提升了文件管理的便捷性和规范性。

🚀 快速开始

安装依赖

npm install

构建项目

npm run build

运行服务器

使用允许目录运行服务器：

npm start /path/to/allowed/directory [/path/to/another/directory ...]

✨ 主要特性

  • 文件操作：支持文件的读取与写入操作。
  • 目录管理：可进行目录的创建、列出和删除操作。
  • 文件移动和重命名：方便对文件进行位置调整和名称修改。
  • 文件元数据检索：能够快速获取文件的元数据信息。
  • 文件搜索功能：便于查找所需文件。
  • 访问控制：通过允许目录实现访问控制，增强安全性。

📚 详细文档

🔧 技术细节

服务器使用以下技术构建：

  • TypeScript：一种强类型的 JavaScript 超集，提升了代码的可维护性和可靠性。
  • MCP SDK（高级别 API）：提供了高级别的接口，简化了开发流程。
  • Node.js 文件系统 API：用于实现底层的文件系统操作。

🔒 安全性

服务器实现路径验证，确保操作仅限于启动时指定的允许目录，有效防止非法访问，保障系统安全。

📄 许可证

本项目采用 ISC 许可证。

help

Runtime guide

cloud

Hosted runtime

Hosted servers run from a provider-managed environment. You usually connect the MCP client to the hosted endpoint or follow the provider's authorization flow, without keeping a local process alive

  1. Open provider connection page
  2. Authorize or copy endpoint
  3. Connect from your MCP client
terminal

Local runtime / other methods

Local servers run on your own machine or infrastructure. You normally copy the server_config into your MCP client, install the required package, and provide env variables from env_schema when needed

  1. Copy server_config
  2. Install required package
  3. Fill env variables and restart client