article
README
🚀 文件系统 MCP 服务器
本项目是为 Claude AI 提供文件系统操作的 Model Context Protocol (MCP) 服务器,能实现多种文件系统操作,为文件管理提供便利。
✨ 主要特性
此 MCP 服务器提供了丰富的文件系统操作功能,具体如下:
-
读取文件:可读取文件的全部内容。
- 输入:
path(字符串),指定文件路径。 - 采用 UTF-8 编码读取完整文件内容。
- 输入:
-
读取多个文件:支持同时读取多个文件。
- 输入:
paths(字符串数组),包含多个文件路径。 - 若部分读取失败,不会停止整个操作。
- 输入:
-
写入文件:可创建新文件或覆盖现有文件。
- 输入:
path(字符串):文件位置。content(字符串):文件内容。
- 输入:
-
创建目录:能创建新目录或确保其存在。
- 输入:
path(字符串),指定目录路径。 - 若需要,会自动创建父目录。
- 若目录已存在,则静默成功。
- 输入:
-
列出目录内容:可列出目录内容,并带有 [FILE] 或 [DIR] 前缀。
- 输入:
path(字符串),指定目录路径。
- 输入:
-
移动文件:用于移动或重命名文件和目录。
- 输入:
source(字符串):源文件/目录路径。destination(字符串):目标文件/目录路径。
- 若目标已存在,则操作失败。
- 输入:
-
搜索文件:可递归搜索文件/目录。
- 输入:
path(字符串):起始目录路径。pattern(字符串):搜索模式。
- 搜索时不区分大小写匹配。
- 返回完整的匹配路径。
- 输入:
-
获取文件信息:能获取文件/目录的详细元数据。
- 输入:
path(字符串),指定文件/目录路径。 - 返回:
- 大小
- 创建时间
- 修改时间
- 访问时间
- 类型(文件/目录)
- 权限
- 输入:
-
列出允许的目录:可列出服务器可以访问的所有目录。
- 无需输入。
- 返回服务器可以读取/写入的目录。
🔒 安全性
服务器仅允许在通过命令行参数指定的目录内执行操作,保障了操作的安全性。
📦 安装指南
- 克隆此仓库。
- 安装依赖项:运行命令
npm install。 - 构建项目:运行命令
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 许可证。
扫码联系在线客服