MCP SynoLink

🚀 SynoLink MCP Server

A Node.js-based server implementing the Model Context Protocol (MCP) for file operations on Synology NAS. This server allows you to interact with your Synology NAS device through Claude or other compatible AI assistants.

✨ Features

• Log in/out of Synology DSM
• List files and folders
• Download file contents
• Upload files
• Create folders
• Delete files/folders
• Move/rename files and folders
• Search functionality
• Create and list shared links
• Get server information
• Get quota information

📋 Prerequisites

• Node.js 18 or higher
• npm or yarn
• Synology NAS with DSM 6.0 or higher
• Network access to your Synology NAS

📦 Installation

Clone this repository:

git clone https://github.com/Do-Boo/MCP-Synolink.git
cd MCP-Synolink

Install dependencies:

npm install

Build the project:

npm run build

💻 Usage Examples with Claude Desktop

Node.js Method

Add the following to your claude_desktop_config.json:

{
  "mcpServers": {
    "synolink": {
      "command": "node",
      "args": [
        "/path/to/MCP-Synolink/dist/index.js",
        "https://your-synology-url:port",
        "your-username",
        "your-password"
      ]
    }
  }
}

Docker Method

Build the Docker image:

docker build -t mcp/synolink .

Then add the following to your claude_desktop_config.json:

{
  "mcpServers": {
    "synolink": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "mcp/synolink",
        "https://your-synology-url:port",
        "your-username",
        "your-password"
      ]
    }
  }
}

Security Note

⚠️ Important Note

Always handle credentials with care. The current implementation passes passwords as command-line arguments, which may be visible in the process list. For better security in a production environment, consider implementing alternative authentication methods.

📚 Documentation

API Documentation

The server provides the following tools:

Authentication Tools

• login

  • Authenticate with the Synology NAS
  • No parameters required (uses credentials from the command line)

• logout

  • Log out of the Synology NAS
  • No parameters required

File Management Tools

• list_folders

  • List files and folders
  • Input: path (Path to list, defaults to the root directory)
  • Output: An array of objects containing information about files and subfolders

• download_file

  • Download a file at the specified path
  • Input: file_path (Path of the file to download)
  • Output: File content stream

• upload_file

  • Upload a file to the specified path
  • Input: file_path (Destination path), data (File data)
  • Output: Confirmation of successful status

• create_folder

  • Create a new folder
  • Input: folder_path (Path of the folder to create)
  • Output: Confirmation of successful status

• delete_file

  • Delete a file at the specified path
  • Input: file_path (Path of the file to delete)
  • Output: Confirmation of successful status

• move_file

  • Move a file to a new location
  • Input: source_path (Source path), destination_path (Destination path)
  • Output: Confirmation of successful status

Shared Link Tools

• create_share_link

  • Create a shared link
  • Input: file_path (Path of the file to share)
  • Output: Shared link URL

• get_share_links

  • Get all shared links
  • Output: An array of information containing all shared links

Information Tools

• get_server_info
  • Get basic server information
  • Output: An object containing information such as server version and status

📄 Notes

⚠️ Important Note

• Ensure the server runs in a secure network environment.
• Regularly update credentials to ensure security.
• Use HTTPS for encrypted communication, especially in a production environment.