convez.ai
MCP Server
RafalManka

synology-mcp

RafalManka/synology-mcp

Ver no GitHub
InicialPluginScore · de 0 a 100

Rust MCP server for Synology NAS. Provide system info, storage health, disk SMART status. Single static binary, runs on-NAS via Docker.

Instalação

$npx convez-ai RafalManka/synology-mcp

1 comando no terminal: detecta o formato do repositório (marketplace ou plugin avulso) e instala via Claude Code. Requer Node 18+ e o Claude Code instalado.

Métricas

Estrelas
7
Forks
1
Acompanhando
1
Saúde
42%
Último commit
há 5 meses
Versão
v0.1.0
Issues abertas
1
Contribuidores
1

README

A tradução para o português deste README ainda está na fila.

synology-mcp

A Rust MCP server for Synology NAS (DSM 7). Single static binary with no runtime dependencies. Runs as a Docker container on the Synology itself and exposes an HTTP MCP endpoint, accessible from Claude, Cursor, ChatGPT etc.

This MCP implementation focuses on home lab monitoring: storage health, disk SMART status, and system utilisation.


Demo

Demo


Supported DSM version

Tested on DSM 7.2+.


Prerequisites

  • Synology NAS with Container Manager enabled
  • A dedicated DSM user for MCP (see Security)
  • DSM reverse proxy configured for HTTPS (Control Panel → Login Portal → Advanced)
  • A domain pointing to your NAS

Installation

1. Download docker-compose.yml from this repo onto your Synology.

2. Create a project in Container Manager

Container Manager → Projects → Create → select the docker-compose.yml. In the environment variables section set:

SYNOLOGY_PASSWORD=your_dsm_password
MCP_AUTH_TOKEN=your_secret_token

Generate a token: openssl rand -hex 32

3. Start the project

Container Manager will pull the image and start the container automatically.

4. Configure DSM reverse proxy

Control Panel → Login Portal → Advanced → Reverse Proxy:

  • Source: https, hostname mcp.yourdomain.com, port 443
  • Destination: http, hostname localhost, port 3006

5. Configure your MCP client

~/.mcp.json (Claude Code) or equivalent:

{
  "mcpServers": {
    "synology": {
      "type": "https",
      "url": "https://mcp.yourdomain.com/mcp",
      "headers": {
        "Authorization": "Bearer <your_MCP_AUTH_TOKEN>"
      }
    }
  }
}

Tools

ToolDescriptionReturns
get_system_infoModel, serial, DSM version, uptime, hostname, temperature, RAMJSON object
get_system_utilisationReal-time CPU%, memory usage, network throughputJSON object
list_packagesAll installed DSM packages with version and statusJSON array
get_volumesStorage volumes: total/used/free GB, status, filesystemJSON array
get_disksEvery drive: model, serial, temperature, health, SMART status, sizeJSON array

Environment variables

VariableDefaultDescription
SYNOLOGY_HOST—NAS IP or hostname, e.g. 127.0.0.1
SYNOLOGY_PORT5001DSM API port
SYNOLOGY_USER—DSM username
SYNOLOGY_PASSWORD—DSM password
SYNOLOGY_HTTPStrueUse HTTPS for DSM API calls
MCP_AUTH_TOKEN—Bearer token required on all MCP requests
MCP_PORT3000Port the MCP server listens on
RUST_LOGsynology_mcp=infoLog level

Building from source

Requires the x86_64-unknown-linux-musl target:

rustup target add x86_64-unknown-linux-musl
cargo build --release --target x86_64-unknown-linux-musl

To build and push to ghcr.io, see deploy.sh.


Why Rust

Single static binary (~5 MB). Runs from a scratch container. No OS, no shell, no runtime. Starts in under a second. The musl target means zero shared library dependencies, so the Docker image is as small as it gets.


Security

The DSM system and storage APIs require administrator-level access. Create a dedicated DSM admin user for MCP. Do not use the built-in admin account. Do not enable 2FA on the MCP user as DSM API auth does not support it. Treat MCP_AUTH_TOKEN like a password and keep it out of version control.

Ver o original no GitHub

Bom para

Relacionados