Pull remote file to local workspace
pull_file_to_workspaceCopies a remote file from an XServer domain into the local workspace, backing up any existing local file before overwriting.
Instructions
Read one remote UTF-8 file and write it under the matching local site workspace path. Existing local files are backed up by default.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"domain": "<domain>",
"path": "<path>"
},
"name": "pull_file_to_workspace"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| path | Yes | File path relative to the configured domain root. | |
| domain | Yes | Configured domain root to operate under. | |
| dry_run | No | Return what would happen without reading or writing. | |
| server_id | No | Server profile id. Defaults to config.defaultServer. | |
| local_backup | No | Back up an existing local file before overwriting it. | |
| workspace_root | No | Local workspace root. Defaults to config.localWorkspaceRoot or ~/Dev/xserver-sites. | |
| allow_sensitive | No | Allow default-excluded paths such as wp-config.php, uploads, logs, backups, and dumps. |