使用说明
📂 文件系统mcp
用于文件系统操作的模型上下文协议(MCP)服务器。使Claude、Cursor等AI助手能够读取、写入和管理本地系统上的文件。
🚀 特性
- 📖 读取文件 -读取有大小限制的文件内容
- 📂 列出目录 -查看包含元数据(大小、类型)的文件
- ✏️ 写入文件 -创建和更新文件
- 🗑️ 删除文件 -删除文件和目录
- 🔍 搜索文件 -球形图案匹配
- 📊 文件信息 -获取详细的元数据
- 📁 目录操作 -创建、复制、移动目录
📦 安装
pip install filesystem-mcp
🔧 用法
命令行接口命令模式
# Start the MCP server (read-write mode)
filesystem-mcp --directory /path/to/your/project
# Start in read-only mode
filesystem-mcp --directory /path/to/your/project --readonly
克劳德桌面版
添加到您的 claude_desktop_config.json:
{
"mcpServers": {
"filesystem": {
"command": "filesystem-mcp",
"args": ["--directory", "/path/to/your/project"]
}
}
}
光标
添加到光标设置(MCP配置):
{
"mcpServers": {
"filesystem": {
"command": "filesystem-mcp",
"args": ["--directory", "/path/to/your/project"]
}
}
}
🛠️ 可用工具
| 工具 | 描述 | 写入 |
|---|---|---|
read_file |
读取文件内容 | ❌ |
list_directory |
列出目录中的文件 | ❌ |
write_file |
创建或写入文件 | ✅ |
delete_file |
删除文件或目录 | ✅ |
create_directory |
创建新目录 | ✅ |
search_files |
按glob模式搜索文件 | ❌ |
get_file_info |
获取文件元数据 | ❌ |
copy_file |
复制文件或目录 | ✅ |
move_file |
移动或重命名文件 | ✅ |
📝 示例
from filesystem_mcp import FileSystemServer
# Create server instance
server = FileSystemServer(root_directory="/path/to/project")
# Run the server
server.run()
🔐 安全
- 路径限制:所有操作都限制在指定的根目录中
- 文件大小限制:文件读取最大1MB
- 可选只读模式:使用
--readonly禁用所有写入操作的标志
🤝 贡献
欢迎投稿!请随时提交拉取请求。
- 分叉存储库
- 创建功能分支(
git checkout -b feature/amazing-feature) - 提交您的更改(
git commit -m 'Add some amazing feature') - 推到分支(
git push origin feature/amazing-feature) - 打开拉取请求
📄 许可证
MIT许可证-请参阅 许可证 了解详情。
