JinDaGe - mcp-filesystem MCP Details

article

README

🚀 MCP 文件系统服务器

MCP 文件系统服务器是一个功能强大且安全的文件管理系统，支持多种文件和目录操作，还具备 Docker 部署能力以及丰富的新特性，能满足多样化的文件管理需求。

🚀 快速开始

# 安装
npm install mcp-filesystem -g

# 启动服务器
mcp-filesystem start --port 3000

# 创建配置文件
mcp-filesystem --create-config config.json

# 根据需要编辑 config.json 并重新启动服务器

📦 安装指南

要使用 MCP 文件系统服务器，请按照以下步骤操作：

1. 安装 Node.js 和 npm/yarn

确保您的系统已安装 Node.js（版本 14 或更高）和 npm 或 yarn。

2. 安装 MCP 文件系统服务器

使用 npm 或 yarn 进行安装：

npm install mcp-filesystem -g
# 或者
yarn global add mcp-filesystem

💻 使用示例

基础用法

启动服务器

在终端中运行以下命令以启动 MCP 文件系统服务器：

mcp-filesystem start --port 3000

将 3000 替换为您所需的端口号。

配置文件生成

要创建配置文件，请运行以下命令：

mcp-filesystem --create-config config.json

✨ 主要特性

核心功能

文件操作：读取、写入、编辑和移动文件。
目录操作：创建、列出、获取树视图和搜索目录。
元数据访问：查看文件和目录信息。
命令执行：安全地执行系统命令。
Docker 支持：通过 Docker 和 Docker Compose 方便部署。

新功能（v0.3.0）

结构化日志记录：详细日志，包括调试、信息、警告和错误级别。
性能指标：跟踪操作计数、错误和执行时间。
配置管理：支持 JSON 配置文件。
路径缓存：提升频繁访问路径的性能。
改进错误处理：专用错误类型，包含结构化信息。
文件大小验证：防止加载过大文件。
CLI 改进：帮助命令、版本信息和配置生成。

📚 详细文档

配置选项

创建配置文件后，您可以根据需要进行调整。以下是一个示例：

{
  "allowedDirectories": ["/path/to/allowed/dir1", "/path/to/allowed/dir2"],
  "logLevel": "info",
  "logFile": "/path/to/logs/mcp-filesystem.log",
  "serverName": "secure-filesystem-server",
  "serverVersion": "0.3.0",
  "cache": {
    "enabled": true,
    "maxSize": 1000,
    "ttlMs": 60000
  },
  "metrics": {
    "enabled": true,
    "reportIntervalMs": 60000
  },
  "security": {
    "maxFileSize": 10485760,
    "allowSymlinks": true,
    "validateRealPath": true
  }
}

安全注意事项

允许目录：仅添加可信路径以防止未经授权的访问。
文件大小限制：根据需求设置 maxFileSize，默认为10MB。
符号链接：根据安全策略选择是否允许符号链接。

文档扩展

如需更详细的文档或遇到问题，请参考官方文档或其他资源。

开发者信息

MCP 文件系统服务器由 [开发者姓名] 开发，旨在提供一个功能强大且安全的文件管理系统。

mcp-filesystem