# Install dependencies
pip install -r requirements.txt

# Run with environment control
python main.py

🔌 Client Setup

🤖 Claude Desktop

Add to your Claude Desktop configuration file:

macOS: ~/Library/Application Support/Claude/claude_desktop_config.json Windows: %APPDATA%\Claude\claude_desktop_config.json

{
  "mcpServers": {
    "synology": {
      "command": "docker-compose",
      "args": [
        "-f", "/path/to/your/mcp-server-synology/docker-compose.yml",
        "run", "--rm", "synology-mcp"
      ],
      "cwd": "/path/to/your/mcp-server-synology"
    }
  }
}

↗️ Cursor

Add to your Cursor MCP settings:

{
  "mcpServers": {
    "synology": {
      "command": "docker-compose",
      "args": [
        "-f", "/path/to/your/mcp-server-synology/docker-compose.yml",
        "run", "--rm", "synology-mcp"
      ],
      "cwd": "/path/to/your/mcp-server-synology"
    }
  }
}

🔄 Continue (VS Code Extension)

Add to your Continue configuration (.continue/config.json):

{
  "mcpServers": {
    "synology": {
      "command": "docker-compose",
      "args": [
        "-f", "/path/to/your/mcp-server-synology/docker-compose.yml",
        "run", "--rm", "synology-mcp"
      ],
      "cwd": "/path/to/your/mcp-server-synology"
    }
  }
}

💻 Codeium

For Codeium's MCP support:

{
  "mcpServers": {
    "synology": {
      "command": "docker-compose",
      "args": [
        "-f", "/path/to/your/mcp-server-synology/docker-compose.yml",
        "run", "--rm", "synology-mcp"
      ],
      "cwd": "/path/to/your/mcp-server-synology"
    }
  }
}

🐍 Alternative: Direct Python Execution

If you prefer not to use Docker:

{
  "mcpServers": {
    "synology": {
      "command": "python",
      "args": ["main.py"],
      "cwd": "/path/to/your/mcp-server-synology",
      "env": {
        "SYNOLOGY_URL": "http://192.168.1.100:5000",
        "SYNOLOGY_USERNAME": "your_username",
        "SYNOLOGY_PASSWORD": "your_password",
        "AUTO_LOGIN": "true",
        "ENABLE_XIAOZHI": "false"
      }
    }
  }
}

🌟 Xiaozhi Integration

New unified architecture supports both clients simultaneously!

How It Works

• ENABLE_XIAOZHI=false (default): Standard MCP server for Claude/Cursor via stdio
• ENABLE_XIAOZHI=true: Multi-client bridge supporting both:
  • 📡 Xiaozhi: WebSocket connection
  • 💻 Claude/Cursor: stdio connection

Setup Steps

1. Add to your .env file:

ENABLE_XIAOZHI=true
XIAOZHI_TOKEN=your_xiaozhi_token_here

2. Run normally:

# Same command, different behavior based on environment
python main.py
# OR
docker-compose up

Key Features

• ✅ Zero Configuration Conflicts: One server, multiple clients
• ✅ Parallel Operation: Both clients can work simultaneously
• ✅ All Tools Available: Xiaozhi gets access to all Synology MCP tools
• ✅ Backward Compatible: Existing setups work unchanged
• ✅ Auto-Reconnection: Handles WebSocket connection drops
• ✅ Environment Controlled: Simple boolean flag to enable/disable

Startup Messages

Claude/Cursor only mode:

🚀 Synology MCP Server
==============================
📌 Claude/Cursor only mode (ENABLE_XIAOZHI=false)

Both clients mode:

🚀 Synology MCP Server with Xiaozhi Bridge
==================================================
🌟 Supports BOTH Xiaozhi and Claude/Cursor simultaneously!

🛠️ Available MCP Tools

🔐 Authentication

• synology_status - Check authentication status and active sessions
• synology_list_nas - List all configured NAS units from settings.json
• synology_login - Authenticate with Synology NAS (conditional)
• synology_logout - Logout from session (conditional)

📁 File System Operations

• list_shares - List all available NAS shares
• list_directory - List directory contents with metadata
  • path (required): Directory path starting with /
• get_file_info - Get detailed file/directory information
  • path (required): File path starting with /
• search_files - Search files matching pattern
  • path (required): Search directory
  • pattern (required): Search pattern (e.g., *.pdf)
• create_file - Create new files with content
  • path (required): Full file path starting with /
  • content (optional): File content (default: empty string)
  • overwrite (optional): Overwrite existing files (default: false)
• create_directory - Create new directories
  • folder_path (required): Parent directory path starting with /
  • name (required): New directory name
  • force_parent (optional): Create parent directories if needed (default: false)
• delete - Delete files or directories (auto-detects type)
  • path (required): File/directory path starting with /
• rename_file - Rename files or directories
  • path (required): Current file path
  • new_name (required): New filename
• move_file - Move files to new location
  • source_path (required): Source file path
  • destination_path (required): Destination path
  • overwrite (optional): Overwrite existing files

📥 Download Station Management

• ds_get_info - Get Download Station information
• ds_list_tasks - List all download tasks with status
  • offset (optional): Pagination offset
  • limit (optional): Max tasks to return
• ds_create_task - Create new download task
  • uri (required): Download URL or magnet link
  • destination (optional): Download folder path
• ds_pause_tasks - Pause download tasks
  • task_ids (required): Array of task IDs
• ds_resume_tasks - Resume paused tasks
  • task_ids (required): Array of task IDs
• ds_delete_tasks - Delete download tasks
  • task_ids (required): Array of task IDs
  • force_complete (optional): Force delete completed
• ds_get_statistics - Get download/upload statistics

🏥 Health Monitoring

• synology_system_info - Get system model, serial, DSM version, uptime, temperature
• synology_utilization - Get real-time CPU, memory, swap, and disk I/O utilization
• synology_disk_health - List all physical disks with SMART status, model, temp, size
• synology_disk_smart - Get detailed SMART attributes for a specific disk
• synology_volume_status - List all volumes with status, size, usage, filesystem type
• synology_storage_pool - List RAID/storage pools with level, status, member disks
• synology_network - Get network interface status and transfer rates
• synology_ups - Get UPS status, battery level, power readings
• synology_services - List installed packages and their running status
• synology_system_log - Get recent system log entries
• synology_health_summary - Aggregate system info, utilization, disk health, and volume status

📦 NFS Management

• synology_nfs_status - Get NFS service status and configuration
• synology_nfs_enable - Enable or disable the NFS service
• synology_nfs_list_shares - List all shared folders with their NFS permissions
• synology_nfs_set_permission - Set NFS client access permissions on a shared folder

🧠 Claude Code / Claude.ai Skill

For Claude Code, Claude Desktop, and claude.ai users, this repo ships an Anthropic Agent Skill that teaches Claude how to use the MCP tools effectively — picking the right tool, targeting the right NAS in multi-NAS setups, preferring aggregate health checks over fan-out calls, and using correct path conventions.

The skill lives at skills/synology-nas/ and uses progressive disclosure across six domains (auth, files, downloads, health, shares/NFS, user management).

Install:

• Claude Code: copy or symlink the folder into ~/.claude/skills/synology-nas/
• Claude.ai / Claude Desktop: upload the synology-nas/ folder via the Skills settings page

The skill is purely additive — it works alongside the MCP and only triggers on Synology/NAS-related prompts.

⚙️ Configuration Options

⚠️ Security Warning: Use a Dedicated Account

For this MCP server, create a dedicated Synology user account with appropriate permissions. This account should:

• NOT have 2FA enabled - The MCP server cannot hand