Synology Docker MCP Server

(Scroll down for English version / 英語版は以下にあります)

🇨🇳 中文说明 (中国語版)

これは、Synology NAS専用に設計されたModel Context Protocol (MCP) サーバーです。大規模言語モデル（LLM）を通じて、Synology Container Manager内のDockerコンテナやDocker Composeプロジェクトを直接管理、設定、デバッグすることを目的としています。

✨ 主な機能とハイライト

• SSHベースの安全な管理: SSH経由でSynology NASと直接通信し、ネイティブコマンドを安全に実行します。Docker TCPインターフェースを外部に公開するリスクを完全に排除します。

• 自動権限昇格 (Auto-Privilege Escalation): 認証情報を自動的に注入して sudo をサイレント実行し、Synologyの管理者アカウントでDocker実行時に発生しがちな Permission Denied の権限問題を解決します。

• Synology Container Managerとの完全な互換性: docker-compose -p タグをネイティブサポートし、強制的に使用することで、このMCPサーバー経由で起動または更新されたプロジェクトが、SynologyのWeb管理画面上のプロジェクトインターフェースと完全に同期（緑色の正常ステータスを維持）されることを保証します。

• 包括的なツールセット:

  • synology_docker_ps: 実行中のすべてのコンテナを表示します。

  • synology_docker_logs: コンテナログを取得・追跡します。

  • synology_docker_manage: コンテナの起動、停止、再起動、削除を制御します。

  • synology_project_list: /volume1/docker/ ディレクトリ配下のすべてのプロジェクトを自動検索・検出します。

  • synology_project_manage: プロジェクトのPull、Up、Down、Restartコマンドをネイティブ実行します。

  • synology_read_file / synology_write_file: .env や docker-compose.yml 設定ファイルをリモートで読み取り・編集します。

🔒 セキュリティ強化記録 (v1.1.0)

🚀 クイックスタート設定

1. Synology SSHサービスの有効化: コントロールパネル -> 端末とSNMP に移動し、SSHサービスを有効にする にチェックを入れます。

2. 環境変数の設定: プロジェクト内の .env.example をコピーして .env にリネームし、NASの接続情報を入力します：

   NAS_HOST=192.168.1.xxx
   NAS_PORT=22
   NAS_USER=your_admin_account
   NAS_PASSWORD=your_admin_password
   NAS_DOCKER_DIR=/volume1/docker

3. 依存関係のインストールとビルド:

   npm install
   npm run build

4. MCPクライアントへの接続 (例: Claude Desktop または Cursor): 以下の内容をクライアントのMCP設定JSONに追加します：

   {
     "mcpServers": {
       "synology-docker": {
         "command": "node",
         "args": [
           "--env-file=e:\\Dev\\Synology Docker MCP\\.env",
           "e:\\Dev\\Synology Docker MCP\\build\\index.js"
         ]
       }
     }
   }

🇬🇧 English Version

This is a Model Context Protocol (MCP) server specifically designed to manage, configure, and debug Docker containers and Docker Compose projects on Synology NAS devices.

✨ Features & Highlights

• SSH-Based Management: Communicates with your Synology NAS directly via SSH, ensuring secure execution of native commands without needing to expose the Docker TCP socket.

• Auto-Privilege Escalation: Automatically injects credentials to run sudo silently, bypassing the Permission Denied issues commonly faced by Synology administrator accounts.

• Synology Container Manager Compatibility: Native support for docker-compose -p, ensuring that projects started or updated via this MCP server perfectly align with the Synology Container Manager GUI (maintaining the green status indicator).

• Comprehensive Toolset:

  • synology_docker_ps: View all running containers.

  • synology_docker_logs: Stream container logs.

  • synology_docker_manage: Start, stop, restart, or remove containers.

  • synology_project_list: Discover projects mapped in /volume1/docker/.

  • synology_project_manage: Pull, up, down, or restart Docker Compose projects natively.

  • synology_read_file / synology_write_file: Edit .env and docker-compose.yml configurations remotely.

🔒 Security Hardening (v1.1.0)

🚀 Setup Instructions

1. Enable SSH on Synology NAS: Go to Control Panel -> Terminal & SNMP and check Enable SSH service.

2. Configure Credentials: Copy .env.example to .env and fill in your NAS connection details:

   NAS_HOST=192.168.1.xxx
   NAS_PORT=22
   NAS_USER=your_admin_account
   NAS_PASSWORD=your_admin_password
   NAS_DOCKER_DIR=/volume1/docker

3. Install Dependencies & Build:

   npm install
   npm run build

4. Connect to MCP Client (e.g. Claude Desktop / Cursor): Add the following to your MCP configuration JSON:

   {
     "mcpServers": {
       "synology-docker": {
         "command": "node",
         "args": [
           "--env-file=e:\\Dev\\Synology Docker MCP\\.env",
           "e:\\Dev\\Synology Docker MCP\\build\\index.js"
         ]
       }
     }
   }