@nyxrux62/synol-mcp/README.md

MCP server for Synology NAS file operations with upload request functionality

# Synol Mcp Server

Fork from [mcp/synolink](https://github.com/Do-Boo/MCP-SynoLink.git)

## 수정 및 변경/추가 사항

- "업로드 요청 링크" 생성(`syno_create_upload_request`)
  ```typescript
  // 예시: '/photos' 폴더에 대한 업로드 요청 링크 생성
  const result = await syno_create_upload_request({
    path: '/photos'
  });
  // 반환값: 업로드 요청 URL 문자열
  ```
  - 지정된 폴더가 없는 경우 자동으로 생성됨
  - 생성된 링크는 다른 사람들이 해당 폴더에 파일을 업로드하는데 사용 가능

- filesystem mcp와 함께 사용할 때 비정상적으로 작동하는 문제 수정.

## Features

- Login/logout to 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 sharing 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

## Usage with Claude Desktop

Add this to your `claude_desktop_config.json`:

```json
{
  "mcpServers": {
    "synol-mcp": {
      "command": "npx",
      "args": [
        "@nyxrux62/synol-mcp",
        "https://your-synology-url:port",
        "your-username",
        "your-password"
      ]
    }
  }
}
```

## API Documentation

The server provides the following tools:

### Authentication Tools

- **login**
  - Authenticates with the Synology NAS
  - No parameters required (uses credentials from command line)

- **logout**
  - Logs out from the Synology NAS
  - No parameters required

### File Management Tools

- **list_folders**
  - Lists files and folders in a directory
  - Input: `path` (string) - Path to list files from, e.g., '/photos'

- **get_file**
  - Gets the content of a file
  - Input: `path` (string) - Full path to the file on Synology NAS

- **upload_file**
  - Uploads a file to Synology NAS
  - Inputs:
    - `path` (string) - Destination path on Synology NAS including filename
    - `content` (string) - Content of the file to upload

- **create_folder**
  - Creates a new folder
  - Inputs:
    - `path` (string) - Full path to create folder at
    - `name` (string) - Name of the new folder

- **delete_item**
  - Deletes a file or folder
  - Input: `path` (string) - Full path to the file or folder to delete

- **move_item**
  - Moves or renames a file or folder
  - Inputs:
    - `source` (string) - Full path to the source file or folder
    - `destination` (string) - Full path to the destination location

### Search and Information Tools

- **search**
  - Searches for files and folders
  - Inputs:
    - `keyword` (string) - Search keyword
    - `path` (string, optional) - Path to search in, defaults to "/"

- **get_share_links**
  - Gets or creates sharing links for a file or folder
  - Input: `path` (string) - Path to get share links for

- **get_server_info**
  - Gets information about the Synology server
  - No parameters required

- **get_quota_info**
  - Gets quota information for volumes
  - Input: `volume` (string, optional) - Volume name, if omitted shows all volumes

## License

MIT License

## Acknowledgements

- [Synology Web API](https://global.download.synology.com/download/Document/Software/DeveloperGuide/Package/FileStation/All/enu/Synology_File_Station_API_Guide.pdf)
- [Model Context Protocol](https://modelcontextprotocol.io/)