使用说明
MCP本地文件系统服务器
一种MCP(模型上下文协议)服务器,提供对本地文件系统操作的安全访问。
特性
- 读取文件:使用可配置的编码读取文件内容
- 写入文件:创建或覆盖文件
- 列出目录:浏览目录内容
- 创建目录:创建新目录(带递归选项)
- 删除文件/目录:删除文件或目录(使用递归选项)
- 移动/重命名:移动或重命名文件和目录
- 文件统计信息:获取详细的文件/目录元数据
- 搜索文件:搜索与模式匹配的文件
安全
服务器实现目录级访问控制。只有在启动时指定的目录是可访问的,防止对文件系统其余部分的未经授权的访问。
安装
npm install
npm run build
用法
使用一个或多个允许的目录启动服务器:
node build/index.js /path/to/allowed/dir1 /path/to/allowed/dir2
或者使用二进制:
mcp-local-filesystem /path/to/allowed/dir1 /path/to/allowed/dir2
光标配置
添加到MCP设置配置中:
{
"mcpServers": {
"local-filesystem": {
"command": "node",
"args": [
"d:\\FILE_SYSTEM_MCP\\build\\index.js",
"C:\\Users\\YourUsername\\Documents",
"D:\\Projects"
]
}
}
}
可用工具
read_file
从文件系统读取文件。
参数:
path(string,必填):文件路径encoding(字符串,可选):要使用的编码(utf-8、ascii、base64)
write_file
将内容写入文件(创建或覆盖)。
参数:
path(string,必填):文件路径content(string,必填):要写的内容encoding(字符串,可选):要使用的编码
list_directory
列出目录中的所有文件和目录。
参数:
path(string,必填):目录路径
create_directory
创建新目录。
参数:
path(string,必填):新目录的路径recursive(boolean,可选):如果需要,创建父目录
删除路径
删除文件或目录。
参数:
path(字符串,必填):要删除的路径recursive(boolean,可选):非空目录必需
move_path
移动或重命名文件或目录。
参数:
source(字符串,必填):源路径destination(字符串,必填):目标路径
获取_文件_状态
获取有关文件或目录的详细信息。
参数:
path(string,必填):文件或目录的路径
搜索文件
搜索与模式匹配的文件。
参数:
directory(字符串,必填):要搜索的目录pattern(字符串,必填):文件名模式(支持*和?)maxResults(数字,可选):最大结果(默认值:100)
资源
服务器将每个允许的目录作为资源公开 file:// URI方案。您可以使用 ReadResource MCP操作浏览目录和读取文件。
发展
# Install dependencies
npm install
# Build
npm run build
# Watch mode for development
npm run watch
许可证
麻省理工学院
