Synology Docker MCP 서버

(영어 버전은 아래로 스크롤하세요 / 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 웹 인터페이스의 프로젝트 목록과 완벽하게 동기화되도록 합니다(녹색 상태 표시 유지).

• 포괄적인 도구 세트:

  • 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"
         ]
       }
     }
   }