URBackup MCP
Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| URBACKUP_URL | No | Server URL (default ports: 55413 HTTP, 55414 HTTPS) | https://localhost:55414 |
| URBACKUP_PASS | No | Admin password | |
| URBACKUP_USER | No | Admin username (empty = anonymous, if the server allows) | |
| URBACKUP_MCP_HOST | No | Bind host for streamable-http (use 0.0.0.0 to reach from other machines) | 127.0.0.1 |
| URBACKUP_MCP_PORT | No | Port for streamable-http | 8765 |
| URBACKUP_VERIFY_SSL | No | Set false for self-signed certificates | true |
| URBACKUP_MCP_TRANSPORT | No | stdio (default) or streamable-http (for Open WebUI / remote MCP) | stdio |
| URBACKUP_MCP_BEARER_TOKEN | No | Required for streamable-http; clients send Authorization: Bearer <token> |
Instructions
Guidance the server publishes about itself, which clients place ahead of the tool catalog so the model reads it before choosing anything.
Tools for managing an UrBackup server: view client status, start and monitor backups, browse and restore files, manage settings, users, logs and storage usage. Client IDs are integers from urbackup_status. Backup IDs: positive = file backup, image backups are listed under backup_images. Destructive tools require confirm=true.
Capabilities
Features and capabilities supported by this server
Protocol revision2025-11-25
| Capability | Details |
|---|---|
| tools | {
"listChanged": false
} |
| prompts | {
"listChanged": false
} |
| resources | {
"subscribe": false,
"listChanged": false
} |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| urbackup_statusB | List all UrBackup clients with online state, last backup times, OS, version, and running processes. Also returns server-level flags (disk space problems, database errors, image/file backup availability). |
| urbackup_status_checkA | Run the server's health check for all clients (connectivity, settings, backup state) and return the results. |
| urbackup_start_backupB | Start a backup for one or more clients. Args: client_ids: Client IDs (from urbackup_status). backup_type: One of incr_file, full_file, incr_image, full_image. |
| urbackup_progressA | Show running backup/restore processes with progress, speed, ETA, and (optionally) the most recent completed activities. |
| urbackup_stop_processB | Stop a running backup/restore process. Args: client_id: Client ID the process belongs to. process_id: Process ID from urbackup_progress. |
| urbackup_list_backupsB | List file and image backups for a client, newest first, with size, incremental flag, archive state and timestamps. |
| urbackup_browse_backup_filesB | Browse files inside a backup. Args: client_id: Client ID. backup_id: Backup ID (from urbackup_list_backups). For image backups use the ID as listed in image_backups. path: Directory path to browse ("" = root). mount_image: Mount the image backup first if needed. |
| urbackup_restore_filesB | Restore files from a backup to the client (client must be online). Args: client_id: Client ID. backup_id: Backup ID to restore from. path: Path of the file or directory inside the backup to restore. file_filter: Optional glob filter for files (e.g. "*.docx"). confirm: Must be true to actually perform the restore. |
| urbackup_restore_imageA | Start an image (disk) restore. Returns a restore token and authkey that the restore client needs. Args: backup_id: Image backup ID (from image_backups in urbackup_list_backups). confirm: Must be true to actually start the restore. |
| urbackup_archive_backupB | Archive a backup (protected from deletion). confirm=true required. |
| urbackup_unarchive_backupC | Remove archive protection from a backup. confirm=true required. |
| urbackup_delete_backupB | Delete a backup. confirm=true required. Args: client_id: Client ID. backup_id: Backup ID. delete_now: Delete immediately instead of marking for deletion. |
| urbackup_download_file_urlC | Get a session-scoped URL to download a single file from a backup. |
| urbackup_download_zip_urlB | Get a session-scoped URL to download a directory from a backup as a zip. |
| urbackup_get_logsB | List backup logs. Args: client_ids: Filter to specific clients (empty = all). log_level: 0 = info and up, 1 = warnings and up, 2 = errors only. |
| urbackup_get_logB | Get the detailed entries of a log (from urbackup_get_logs). |
| urbackup_get_general_settingsA | Get general server settings (backup folder, limits, cleanup window, speed limits, quotas, ...). |
| urbackup_save_general_settingsA | Update general server settings. Only pass the keys to change. confirm=true required. See urbackup_get_general_settings for current values. |
| urbackup_get_client_settingsB | Get settings for a client (backup frequencies, windows, paths, exclusions, quotas, ...). Values show the effective value plus the server/group/client origin. |
| urbackup_save_client_settingsA | Update settings for a client. Only pass the keys to change. confirm=true required. Examples: {"default_dirs": "C:\Users|User files"} {"update_freq_incr": 14400} {"exclude_files": ".mp3;.avi"} |
| urbackup_get_mail_settingsA | Get mail server settings (password is masked). |
| urbackup_save_mail_settingsB | Update mail server settings. Pass testmailaddr to send a test mail. confirm=true required. |
| urbackup_list_usersA | List server users with their rights. |
| urbackup_create_userB | Create a server user. rights format: "domain=right;domain=right" e.g. "all=all" or "status=all;progress=all". confirm=true required. |
| urbackup_change_user_rightsB | Change a user's rights. confirm=true required. |
| urbackup_change_user_passwordB | Change a user's password. confirm=true required. |
| urbackup_remove_userA | Remove a server user. confirm=true required. |
| urbackup_usage_statsB | Storage usage per client (file + image bytes used). |
| urbackup_usage_graphC | Storage usage over time. Args: scale: d = daily, m = monthly, y = yearly. client_id: Optional client to filter by. |
| urbackup_add_extra_clientB | Add an extra (non-client) host to the status page, e.g. a NAS. confirm=true required. |
| urbackup_shutdownB | Shut down the UrBackup server. confirm=true required. |
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |
TDQS
Scored across 31 tools
Most tools map to a clear resource+action pair (restore_files vs restore_image, archive vs unarchive vs delete, start_backup vs stop_process). The only real collision is urbackup_get_logs (list logs) versus urbackup_get_log (fetch entries of a log), plus a softer overlap between urbackup_status, urbackup_status_check and urbackup_progress, but descriptions make the intent separable.
All names share the urbackup_ prefix and snake_case, and the dominant pattern is verb_noun (get_general_settings, save_client_settings, create_user, remove_user, delete_backup). The deviations are noun-only names such as urbackup_status, urbackup_progress, urbackup_status_check, urbackup_usage_stats and urbackup_usage_graph, which break the pattern but remain readable.
31 tools is on the heavy side, and the surface can feel crowded across settings, users, stats, monitoring and restore paths. However, UrBackup is a full backup-server administration API and nearly every tool covers a distinct administrative operation, so the count is defensible rather than bloated.
Coverage is strong: backup lifecycle (start/list/archive/unarchive/delete), restore (files, image, browse, downloads), settings (general, client, mail), user CRUD with rights and passwords, logs, process control, and usage stats. Notable gaps are client/group management (no create/remove client, no group-level settings even though group origin is referenced) and no way to remove or edit extra clients.