README
🚀 rclone-mcp
rclone-mcp 是一个为 Rclone RC API 提供支持的 MCP(Model Context Protocol)服务器。它赋予 AI 助手通过自然语言管理云存储远程设备、复制/同步文件、列出目录等能力。工具是根据 rclone-openapi 规范,使用 rclone-sdk 客户端自动生成的,拥有 98 个端点,并组织成可选择的工具集。
🚀 快速开始
在使用 rclone-mcp 之前,需要运行一个 rclone 远程控制守护进程:
rclone rcd --rc-no-auth
# 或者使用认证:
rclone rcd --rc-user=admin --rc-pass=secret
📦 安装指南
Cursor / Claude Desktop (stdio)
将以下内容添加到 .cursor/mcp.json 或 claude_desktop_config.json 中:
{
"mcpServers": {
"rclone": {
"command": "npx",
"args": ["-y", "rclone-mcp"],
"env": {
"RCLONE_URL": "http://localhost:5572"
}
}
}
}
使用认证
{
"mcpServers": {
"rclone": {
"command": "npx",
"args": ["-y", "rclone-mcp"],
"env": {
"RCLONE_URL": "http://localhost:5572",
"RCLONE_USER": "admin",
"RCLONE_PASS": "secret"
}
}
}
}
Docker
docker build -t rclone-mcp .
docker run -i --rm \
-e RCLONE_URL=http://host.docker.internal:5572 \
rclone-mcp
可流式传输的 HTTP 传输
对于远程托管或基于 Web 的 MCP 客户端:
npx rclone-mcp http --port 3000
📚 详细文档
配置
环境变量
| 变量 | 描述 | 默认值 |
|------|------|------|
| RCLONE_URL | rclone RC 守护进程的 URL | http://localhost:5572 |
| RCLONE_USER | HTTP 基本认证用户名 | — |
| RCLONE_PASS | HTTP 基本认证密码 | — |
| RCLONE_TOOLSETS | 以逗号分隔的工具集列表 | default |
| RCLONE_READ_ONLY | 设置为 1 以禁用写工具 | — |
CLI 参数
rclone-mcp [command]
命令:
rclone-mcp stdio 使用标准输入输出传输运行(默认)
rclone-mcp http 使用可流式传输的 HTTP 传输运行
选项:
--toolsets 以逗号分隔的工具集列表
--read-only 仅暴露只读工具
--port HTTP 端口(仅适用于 http 命令,默认值:3000)
工具集
工具按 API 路径前缀分组。你可以只启用你需要的工具集,以保持工具列表的针对性。
| 工具集 | 路径 | 默认启用 |
|------|------|------|
| core | /core/*, /rc/* | 是 |
| config | /config/* | 是 |
| operations | /operations/* | 是 |
| sync | /sync/* | 是 |
| jobs | /job/* | 否 |
| vfs | /vfs/* | 否 |
| mount | /mount/* | 否 |
| serve | /serve/* | 否 |
| cache | /cache/* | 否 |
| debug | /debug/* | 否 |
| backend | /backend/* | 否 |
| options | /options/* | 否 |
| plugins | /pluginsctl/* | 否 |
| fscache | /fscache/* | 否 |
特殊值:
default— 四个默认工具集(core、config、operations、sync)all— 所有工具集
示例
# 默认工具集(55 个工具)
npx rclone-mcp
# 所有工具(98 个工具)
RCLONE_TOOLSETS=all npx rclone-mcp
# 仅文件操作和配置
npx rclone-mcp --toolsets operations,config
# 默认 + 挂载
npx rclone-mcp --toolsets default,mount
# 只读模式(无复制、删除、同步等操作)
npx rclone-mcp --read-only
只读模式
当设置 --read-only 或 RCLONE_READ_ONLY=1 时,仅注册非修改性工具。这排除了文件复制/移动/删除、同步、配置创建、挂载/卸载等操作。这对于为 AI 助手提供安全的只读访问非常有用。
📄 许可证
本项目采用 MIT 许可证。
Scan to join WeChat group