SFTP Plugin for Dify

Author: Steven Lynn Version: 0.0.1 Type: tool

Description

SFTP (Secure File Transfer Protocol) plugin for Dify, allowing secure file operations on remote servers. The plugin provides file listing, downloading, uploading, and management capabilities.

Features

The plugin provides the following actions:

1. List Directory

Lists files and directories in a remote location via SFTP, showing details like file size, modification time, and file type.

2. Download File

Downloads a file from the remote server and returns it directly as a file attachment for easy access.

3. Upload File

Uploads files to the remote server using Dify's file variable system for direct file uploads.

4. Manage Files and Directories

Provides various file and directory management operations:

• Create directory
• Delete file/directory
• Rename file/directory

Authentication

The plugin supports two authentication methods:

• Password authentication: Using username and password
• Private key authentication: Using username and private key (with optional passphrase)

Parameters

Common Parameters for All Tools

Parameter	Type	Required	Description
host	string	Yes	Hostname or IP address of the remote server
port	number	No	SSH port, default is 22
username	string	Yes	Username for authentication
auth_type	select	Yes	Authentication type: password or key
password	string	Conditional	Password for password authentication (required if auth_type is password)
private_key	string	Conditional	Private key content for key authentication (required if auth_type is key)
passphrase	string	No	Passphrase for the private key (if the key is encrypted)

List Directory Parameters

Parameter	Type	Required	Description
remote_path	string	Yes	Directory path on the remote server to list

Download File Parameters

Parameter	Type	Required	Description
remote_path	string	Yes	Path to the file on the remote server

Upload File Parameters

Parameter	Type	Required	Description
remote_path	string	Yes	Path where to save the file on the remote server
files	files	Yes	File(s) to upload to the remote server

Manage Files Parameters

Parameter	Type	Required	Description
action	select	Yes	Action to perform (rename, delete, create directory)
path	string	Yes	Path to file or directory on remote server
new_path	string	Conditional	New path for rename operation (required if action is rename)

Usage Examples

List Directory Example

{
    "host": "example.com",
    "port": 22,
    "username": "user",
    "auth_type": "password",
    "password": "your_password",
    "remote_path": "/home/user"
}

Download File Example

{
    "host": "example.com",
    "port": 22,
    "username": "user",
    "auth_type": "password",
    "password": "your_password",
    "remote_path": "/home/user/file.txt"
}

Upload File Example

{
    "host": "example.com",
    "port": 22,
    "username": "user",
    "auth_type": "key",
    "private_key": "-----BEGIN RSA PRIVATE KEY-----\n...\n-----END RSA PRIVATE KEY-----",
    "remote_path": "/home/user/",
    "files": [file1, file2]
}

Manage Files Example

{
    "host": "example.com",
    "port": 22,
    "username": "user",
    "auth_type": "password",
    "password": "your_password",
    "action": "mkdir",
    "path": "/home/user/new_directory"
}

Security Considerations

• Ensure you have permission to access the target server
• Sensitive information such as private keys and passwords should be kept secure
• Store sensitive credentials in the Dify Environment Variables section as secrets
• Follow the principle of least privilege when accessing remote servers

License

MIT

Feedback and Issues

If you encounter any problems or have suggestions for improvements:

1. Please open an issue in the plugin's GitHub repository

2. Provide details about your problem, including error messages and steps to reproduce

3. Do not submit issues to the main Dify repository for plugin-specific problems