synology-mcp
Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| SYNOLOGY_URL | Yes | URL de DSM con puerto: http://IP:5000 o https://nombre:5001 | |
| SYNOLOGY_PASSWORD | Yes | Contraseña de DSM | |
| SYNOLOGY_USERNAME | Yes | Usuario de DSM | |
| SYNOLOGY_DEVICE_ID | No | Token de register-device para cuentas con 2FA | |
| SYNOLOGY_READ_ONLY | No | false permite crear, mover, borrar y añadir descargas | true |
| SYNOLOGY_DEVICE_NAME | No | Nombre con el que se registró el dispositivo | synology-mcp |
| SYNOLOGY_INSECURE_TLS | No | Acepta un certificado HTTPS autofirmado o caducado (solo en una red de confianza) | false |
| SYNOLOGY_TASK_TIMEOUT_MS | No | Cuánto espera una herramienta a una tarea larga antes de devolver su taskid | 60000 |
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 a Synology NAS (DSM 7.2+). File Station tools use NAS paths that start with a shared folder, e.g. /photo/2024/img.jpg (call list_shares first if unsure). drive_* tools use Synology Drive paths: /mydrive/... (the user's My Drive, which is /home/Drive in File Station), /team-folders//..., or id:<file_id>. get_system_info gives model, DSM version, temperature and uptime (any user). get_system_utilization (CPU, RAM, network, disk I/O), get_storage_status (pools, volumes, disks), get_disk_health (SMART per disk), check_updates (DSM and packages), get_notifications and get_system_logs need an admin account. downloads_* tools manage Download Station tasks; their destinations are NAS folders like /home/Descargas.
Capabilities
Features and capabilities supported by this server
Protocol revision2025-11-25
| Capability | Details |
|---|---|
| tools | {
"listChanged": true
} |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| get_infoA | Get File Station info for the logged-in user: hostname, whether it is an admin, and sharing support. |
| list_sharesA | List the shared folders (top-level roots such as /photo, /video, /home) with free/total space. |
| list_filesA | List files and folders inside a NAS folder. Supports paging, sorting, glob filtering and file type filtering. |
| get_file_infoB | Get details (size, dates, owner, real path on the volume) for one or more files/folders. |
| search_filesA | Search recursively for files/folders by name pattern, extension, size, date or owner. Waits for the search to finish (up to the task timeout) and returns matches. |
| get_dir_sizeB | Calculate total size, number of files and number of folders for one or more paths. |
| get_md5C | Calculate the MD5 checksum of a file on the NAS. |
| read_fileA | Read a file from the NAS and return its content: text files as text, images (png/jpg/gif/webp) as an image. Refuses files larger than max_bytes. |
| download_fileA | Download files/folders from the NAS to a local path on this computer. Several paths (or a folder) are downloaded as a single ZIP. |
| list_sharing_linksC | List the public sharing links created by the user. |
| list_background_tasksA | List File Station background tasks (copy, move, delete, compress, extract) and their progress. |
| get_task_statusB | Check progress of a background task that was still running when a previous tool returned its task id. |
| get_system_infoA | Basic NAS status: model, DSM version, RAM, temperature (and whether it is in warning), uptime, NAS clock and which packages used by these tools (Synology Drive, Download Station, Photos) are installed. Works without admin rights. |
| get_system_utilizationA | Live CPU (% and load average), memory (RAM and swap), network throughput and per-disk / per-volume I/O. Needs a DSM administrator account; normal users get an explanatory error. |
| get_storage_statusA | Storage pools (RAID type, status, member disks), volumes (filesystem, used/free space, status and warnings such as fs_almost_full) and internal disks (model, size, temperature, SMART status, bad sectors). Serial numbers are not returned. Needs a DSM administrator account. |
| get_disk_healthA | Per-disk health from Storage Manager: overall status, SMART status and last test, bad sectors (and whether they are growing), power-on hours, remaining life, temperature and the SMART attributes that matter (or all of them). Needs a DSM administrator account. Serial numbers are never returned. |
| check_updatesA | Whether a DSM update is available (version, whether it is a security update and whether it needs a reboot) and which installed packages have a newer version in the Package Center. Only checks; installs nothing. Needs a DSM administrator account. |
| get_notificationsA | Recent notifications from the DSM desktop (the bell): errors, warnings and events such as finished downloads, failed backups, disk warnings or failed certificate renewals. Each has its time, level, event name and parameters. Needs a DSM administrator account. |
| get_system_logsA | Entries from the NAS's own logs (Log Center): 'system' (services, certificates, disks, updates…) or 'connection' (sign-ins, failed logins, by user and IP). Filter by level, text and dates. Newest first. Needs a DSM administrator account. |
| drive_listB | List a Synology Drive folder (My Drive or a team folder). Use drive_list_team_folders to find team folders. |
| drive_get_infoA | Details of one Drive file or folder: size, owner, labels, star, sharing state, file_id and permanent link. |
| drive_recentC | Files and folders the user used recently in Synology Drive. |
| drive_starredC | Files and folders the user marked with a star in Synology Drive. |
| drive_shared_with_meC | Files and folders other users shared with the logged-in user. |
| drive_shared_with_othersB | Files and folders of the user (My Drive or team folders) that are shared with other people. |
| drive_searchA | Search Synology Drive by name/content keyword, type, location, labels, owner, size or date. Newly added files can take a few seconds to be indexed. |
| drive_list_labelsB | The user's Synology Drive labels with their IDs and colors. |
| drive_list_labelledA | Files and folders that carry a given label (label_id from drive_list_labels). |
| drive_list_permissionsC | Who has access to a Drive file or folder and with which role. |
| drive_list_team_foldersA | Team folders the user can access. Browse them with drive_list and path /team-folders/. |
| downloads_infoB | Download Station version, whether the user manages it, default destination folder, speed limits and the current total download/upload speed. |
| downloads_listA | List download tasks with status, progress, size, speeds and destination. Filter by status, type or text in the title. Also returns how many tasks there are in each status. |
| downloads_getB | Full details of download tasks: source URL, owner, peers, files inside a torrent and trackers. |
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 33 tools
Tools are partitioned by subsystem (File Station, system/storage, Synology Drive, Download Station) with distinct descriptions, so overlaps like list_files vs drive_list vs list_shares are resolvable. Minor confusion remains: bare 'get_info' (File Station user info) sits next to 'get_system_info', and drive_list_labels vs drive_list_labelled are near-homonyms. Overall mostly distinct with a couple of easily-mistaken pairs.
Consistent snake_case verb_noun pattern dominates: list_files, get_file_info, search_files, get_disk_health, drive_search, downloads_list. Deviations are minor: differing prefix conventions (drive_ singular vs downloads_ plural), noun-number inconsistency (list_files vs get_info/get_md5), and the vague bare 'get_info'.
33 tools is heavy for a single server, though it legitimately spans four distinct subsystems (files, system health, Drive, Download Station). Each tool does earn a place individually, but the surface is large enough that an agent must scan many similar-sounding entries. Borderline over-scoped rather than bloated with filler.
Read/query coverage is thorough, but the surface is essentially read-only: no upload, create folder, copy/move/delete/rename, or share-link creation, even though background tasks for those operations are listed. Download Station is likewise read-only (info/list/get but no add, pause, or remove task). Agents asked to modify anything will hit a dead end.