README
🚀 文件系统 MCP 服务器
这是一个用 Go 语言实现的服务器,遵循模型上下文协议(MCP),专门用于文件系统操作。它为文件系统的各类操作提供了便捷、高效的解决方案。
🚀 快速开始
安装服务器
go install github.com/mark3labs/mcp-filesystem-server
配置 Claude Desktop
将以下内容添加到 claude_desktop_config.json 中:
{
"mcpServers": {
"filesystem": {
"command": "mcp-filesystem-server",
"args": [
"/Users/username/Desktop",
"/path/to/other/allowed/dir"
]
}
}
}
✨ 主要特性
- 文件读写:支持读取和写入文件,满足数据的存储与获取需求。
- 目录管理:可创建、列出和删除目录,灵活组织文件系统结构。
- 文件移动:能够移动文件或目录,方便文件的整理和重命名。
- 文件搜索:支持递归搜索文件和目录,快速定位所需文件。
- 元数据获取:可以获取文件和目录的详细元数据,包括大小、时间和权限等。
⚠️ 重要提示
该服务器仅允许在通过
args指定的目录中执行操作。
📚 详细文档
🔍 API 说明
资源
file://system:文件系统操作接口
工具
-
read_file
- 功能:读取文件的完整内容。
- 输入:
path(字符串) - 说明:使用 UTF-8 编码读取整个文件内容。
-
read_multiple_files
- 功能:同时读取多个文件。
- 输入:
paths(字符串数组) - 说明:失败的读取不会停止整个操作。
-
write_file
- 功能:创建新文件或覆盖现有文件(使用此功能时要小心)。
- 输入:
path(字符串):文件路径content(字符串):文件内容
-
create_directory
- 功能:创建新目录或确保目录存在。
- 输入:
path(字符串) - 说明:如果需要,创建父目录;若目录已存在则操作成功但不提示。
-
list_directory
- 功能:列出目录内容,带有 [FILE] 或 [DIR] 前缀。
- 输入:
path(字符串)
-
move_file
- 功能:移动或重命名文件和目录。
- 输入:
source(字符串)destination(字符串)
- 说明:如果目标已存在则操作失败。
-
search_files
- 功能:递归搜索文件/目录。
- 输入:
path(字符串):起始目录pattern(字符串):搜索模式
- 说明:不区分大小写匹配,返回完整路径的匹配项。
-
get_file_info
- 功能:获取文件/目录的详细元数据。
- 输入:
path(字符串) - 返回:
- 大小
- 创建时间
- 修改时间
- 访问时间
- 类型(文件/目录)
- 权限
-
list_allowed_directories
- 功能:列出服务器允许访问的所有目录。
- 输入:无
- 返回:此服务器可以读取/写入的目录
📄 许可证
此 MCP 服务器根据 MIT 许可证发布。这意味着您可以自由使用、修改和分发软件,但需遵守 MIT 许可证的条款和条件。有关更多详细信息,请参阅项目存储库中的 LICENSE 文件。
Scan to contact