内容
📂 文件系统 MCP
<p align="center">
<a href="https://pypi.org/project/filesystem-mcp/">
<img src="https://img.shields.io/pypi/v/filesystem-mcp" alt="PyPI">
>
<a href="https://python.org/downloads/">
<img src="https://img.shields.io/pypi/pyversions/filesystem-mcp" alt="Python">
</a>
<a href="https://opensource.org/licenses/MIT">
<img src="https://img.shields.io/pypi/l/filesystem-mcp" alt="License">
</a>
</p>
系统操作的模型上下文协议(MCP)服务器。启用Claude、Cursor等AI助手在本地系统上读取、写入和管理文件。
## 🚀 功能特点
- 📖 **读取文件** - 读取文件内容,带有大小限制
- 📂 **列出目录** - 查看文件及其元数据(大小、类型)
- ✏️ **写入文件** - 创建和更新文件
- 🗑️ **删除文件** - 删除文件和目录
- 🔍 **搜索文件** - 通配符模式匹配
- 📊 **文件信息** - 获取详细元数据
- 📁 **目录操作** - 创建、复制、移动目录
## 📦 安装
```bash
pip install filesystem-mcp
```
## 🔧 使用方法
### 命令行模式
```bash
# 启动MCP服务器(读写模式)
filesystem-mcp --directory /path/to/your/project
# 以只启动
filesystem-mcp --path/to/your/project --readonly
```
### Claude 桌面版
在 `claude_desktop_config.json` 中添加:
```json
{
"mcpServers": {
"filesystem": {
"command": "filesystem-mcp",
"args": ["--directory", "/path/to/your/project"]
}
}
}
Cursor
在Cursor设置(MCP配置)中添加:json
{
"mcpServers": {
"filesystem": "command": "filesystem-m "args": ["--directory", "/path/to/your/project }
}
}
```
## 🛠️ 可用工具
| | 描述 | 写入 |
|-------|
| `read_file 读取文件内容 | ❌ |
| `list_directory` | 列出目录中的文件 | ❌ |
| `write_file` | 创建或 | ✅ |
| `delete | 删除文件或目录 | ✅ |
| `create_directory` | 创建新目录 | ✅ |
| `` | 按通配符文件 | ❌ |
| `get_file_info` | 获取文件 | ❌ |
| `copy | 复制文件或 ✅ |
| `move_file` | 移动或重命名文件 |
## 📝 示例
```from filesystem_mcp import FileSystemServer
# 创建服务器实例
server = FileSystemServer(root_directory="/path/to/project")
# 运行服务器
server.run()
```
## 🔐 安全
- **路径限制**:所有操作都限制在指定的根目录内
- **文件大小限制**:文件读取的最大大小为1MB
- **可选只读模式**:使用 `--readonly` 标志禁用所有写入操作
## 🤝 贡献
欢迎贡献!请随意提交请求。
1. 分叉仓库
2. 创建功能分支 (` -b feature/amazing-feature`)
3. 提交更改 (`git commit -m 'Add some amazing feature'`)
4. 推送到分支 (` origin feature/amazing-feature`)
打开拉取请求
## 📄 许可证
MIT 许可证 - 参见 [LICENSE](LICENSE了解详情。