MinerU
Transforms complex documents like PDFs and Office docs into LLM-ready markdown/JSON for your Agentic workflows.
SFTP-only file access for AI: browse, edit, transfer and sync files, no shell access needed.
作者提供的原文
教 AI 做这类工作的 Skill,可与本项一起使用
Transforms complex documents like PDFs and Office docs into LLM-ready markdown/JSON for your Agentic workflows.
Agent skills for Obsidian. Teach your agent to use Obsidian CLI and open formats including Markdown, Bases, JSON Canvas.
列表按使用分(满分 100)排序,由以下部分组成
| 热度 | 0/80 | GitHub 星标或每周下载量:较大的计 60,较小的计 20 |
|---|---|---|
| 新鲜度 | 12/12 | 30 天内有发布或代码更新得满分 |
| 仍在响应 | 0/8 | 上次检查时云端端点有响应 |
| 使用分 | 12/100 |
质量: 基础检查通过 3/3 项(仅展示,不用于排序) · 上升势头: 暂无数据 (只用于“上升中”标签)
选择你使用的 AI 应用,然后复制设置。
用一句话让 AI 帮你安装
请帮我安装 SFTP。按照 https://mcp.popnx.com/i/adverstm-sftp-mcp.md 操作,先把命令给我看,等我同意后再运行。粘贴到能在你电脑上工作的 AI(如 Claude Code、Cursor)。它会读取我们的步骤,先给你看命令,等你同意。无需密钥,无需注册。 · 查看 AI 会读取的全文
通过 3/3 项检查 · 在你的电脑上运行 · ✓ 命令已检查 2026年11月14日
第一步:你用哪个 AI?
选择你用的应用,步骤会显示在下方。
可连接 Claude,但需要先准备
需要 SFTP 的密钥(在开发者网站创建) · 需要先在电脑上安装 Node.js(只需一次) · 仅限电脑上的 Claude 应用(Windows 或 Mac),网页和手机不可用
把这段话复制到 Claude 的对话里。AI 会先检查电脑,告诉你要改哪个文件,并且每次都等你同意。
请在这台电脑上为 Claude 安装 MCP server SFTP,按顺序:1) 用 node -v 检查是否有 Node.js。没有的话,请让我从 https://nodejs.org/en/download 安装,不要自己安装。2) 只使用这份配置(已通过 PopNx MCP 检查):{ "mcpServers": { "sftp": { "command": "npx", "args": [ "-y", "sftp-mcp" ], "env": { "SFTP_PASSWORD": "your-value", "SFTP_PRIVATE_KEY": "your-value", "SFTP_PASSPHRASE": "your-value" } } } } 3) 告诉我要修改的文件完整路径或要运行的命令,等我同意。4) SFTP_PASSWORD, SFTP_PRIVATE_KEY, SFTP_PASSPHRASE 先保留 "your-value",请我自己把真实值粘贴到文件或应用的输入框里。不要让我在对话里输入密钥。5) 按约定执行,然后确认 SFTP 的工具真的出现了。这段话不包含你的密钥。如果需要密钥,AI 会请你自己粘贴到文件或应用的输入框里。
已经装好了吗?先检查 · 打开终端,输入这条命令后按 Enter
node -vMac:按 ⌘ + Space,输入 Terminal 后按 Enter
Windows:打开“开始”菜单,输入 Windows PowerShell,然后选“打开”
还没安装: 打开官方下载页,选择 LTS 版本和点选式安装程序:Mac 用 .pkg · Windows 用 .msi。双击后一路下一步即可,不需要 curl 命令
装好后关掉终端再打开,重新运行同一条命令,应显示版本号: node -v
安装一次,所有需要 Node.js 的工具都能用
SettingsDeveloperEdit Config
{
"mcpServers": {
"sftp": {
"command": "npx",
"args": [
"-y",
"sftp-mcp"
],
"env": {
"SFTP_PASSWORD": "your-value",
"SFTP_PRIVATE_KEY": "your-value",
"SFTP_PASSPHRASE": "your-value"
}
}
}
}只把密钥粘贴到应用的输入框里,不要粘贴到聊天中或发给任何人
用 SFTP 告诉我你能帮我做什么,然后做一件给我看✓ 如果 Claude 说正在使用 SFTP,或回答中出现 SFTP 的工具名称,就表示连接成功
上面的命令不填这些也能用。想调整时再按开发者的说明添加。
SFTP_HOST SSH 主机(单服务器模式)。 SFTP_PORT SSH 端口。 SFTP_USER SSH 用户名(单服务器模式) SFTP_SERVERS_FILE 指向 JSON 映射文件的路径,该映射将服务器 ID 对应到连接信息,用于多服务器配置。会替代单服务器变量。 SFTP_READ_ONLY 拒绝所有远程变更操作。 SFTP_ALLOW_DESTRUCTIVE 设置为 false 以拒绝 delete、rmdir、rename 以及非 dry-run 的 sync。 SFTP_ALLOWED_WRITE_PREFIX 修改操作所限定的绝对远程路径前缀。 SFTP_ALLOWED_READ_PREFIX 读取操作所限定的绝对远程路径前缀。 说明为自动翻译,变量名保持原样;不确定时请查看原文。
菜单名称已于 2026年11月11日 对照 Anthropic 帮助页面核实 · 你的界面可能因版本略有不同
ChatGPT 暂时无法连接 SFTP
SFTP 需要安装在你的电脑上,而 ChatGPT 只能连接在网上运行的服务器
A · 使用能连接 SFTP 的应用
可连接 Claude Code,但需要先准备
需要 SFTP 的密钥(在开发者网站创建) · 需要先在电脑上安装 Node.js(只需一次)
把这段话复制到 Claude Code 的对话里。AI 会先检查电脑,告诉你要改哪个文件,并且每次都等你同意。
请在这台电脑上为 Claude Code 安装 MCP server SFTP,按顺序:1) 用 node -v 检查是否有 Node.js。没有的话,请让我从 https://nodejs.org/en/download 安装,不要自己安装。2) 只使用这份配置(已通过 PopNx MCP 检查):claude mcp add --scope user sftp --env SFTP_PASSWORD=your-value --env SFTP_PRIVATE_KEY=your-value --env SFTP_PASSPHRASE=your-value -- npx -y sftp-mcp 3) 告诉我要修改的文件完整路径或要运行的命令,等我同意。4) SFTP_PASSWORD, SFTP_PRIVATE_KEY, SFTP_PASSPHRASE 先保留 "your-value",请我自己把真实值粘贴到文件或应用的输入框里。不要让我在对话里输入密钥。5) 按约定执行,然后确认 SFTP 的工具真的出现了。这段话不包含你的密钥。如果需要密钥,AI 会请你自己粘贴到文件或应用的输入框里。
已经装好了吗?先检查 · 打开终端,输入这条命令后按 Enter
node -vMac:按 ⌘ + Space,输入 Terminal 后按 Enter
Windows:打开“开始”菜单,输入 Windows PowerShell,然后选“打开”
还没安装: 打开官方下载页,选择 LTS 版本和点选式安装程序:Mac 用 .pkg · Windows 用 .msi。双击后一路下一步即可,不需要 curl 命令
装好后关掉终端再打开,重新运行同一条命令,应显示版本号: node -v
安装一次,所有需要 Node.js 的工具都能用
Mac:按 Command+空格,输入 Terminal · Windows:打开 PowerShell
claude mcp add --scope user sftp --env SFTP_PASSWORD=your-value --env SFTP_PRIVATE_KEY=your-value --env SFTP_PASSPHRASE=your-value -- npx -y sftp-mcp按 Enter 前,把“your-value”改成你的密钥
只把密钥粘贴到应用的输入框里,不要粘贴到聊天中或发给任何人
应能看到 SFTP 在列表中并显示已连接
用 SFTP 告诉我你能帮我做什么,然后做一件给我看✓ 如果 Claude Code 说正在使用 SFTP,或回答中出现 SFTP 的工具名称,就表示连接成功
上面的命令不填这些也能用。想调整时再按开发者的说明添加。
SFTP_HOST SSH 主机(单服务器模式)。 SFTP_PORT SSH 端口。 SFTP_USER SSH 用户名(单服务器模式) SFTP_SERVERS_FILE 指向 JSON 映射文件的路径,该映射将服务器 ID 对应到连接信息,用于多服务器配置。会替代单服务器变量。 SFTP_READ_ONLY 拒绝所有远程变更操作。 SFTP_ALLOW_DESTRUCTIVE 设置为 false 以拒绝 delete、rmdir、rename 以及非 dry-run 的 sync。 SFTP_ALLOWED_WRITE_PREFIX 修改操作所限定的绝对远程路径前缀。 SFTP_ALLOWED_READ_PREFIX 读取操作所限定的绝对远程路径前缀。 说明为自动翻译,变量名保持原样;不确定时请查看原文。
菜单名称已于 2026年11月11日 对照 Anthropic 帮助页面核实 · 你的界面可能因版本略有不同
可连接 Cursor,但需要先准备
需要 SFTP 的密钥(在开发者网站创建) · 需要先在电脑上安装 Node.js(只需一次)
把这段话复制到 Cursor 的对话里。AI 会先检查电脑,告诉你要改哪个文件,并且每次都等你同意。
请在这台电脑上为 Cursor 安装 MCP server SFTP,按顺序:1) 用 node -v 检查是否有 Node.js。没有的话,请让我从 https://nodejs.org/en/download 安装,不要自己安装。2) 只使用这份配置(已通过 PopNx MCP 检查):{ "mcpServers": { "sftp": { "command": "npx", "args": [ "-y", "sftp-mcp" ], "env": { "SFTP_PASSWORD": "your-value", "SFTP_PRIVATE_KEY": "your-value", "SFTP_PASSPHRASE": "your-value" } } } } 3) 告诉我要修改的文件完整路径或要运行的命令,等我同意。4) SFTP_PASSWORD, SFTP_PRIVATE_KEY, SFTP_PASSPHRASE 先保留 "your-value",请我自己把真实值粘贴到文件或应用的输入框里。不要让我在对话里输入密钥。5) 按约定执行,然后确认 SFTP 的工具真的出现了。这段话不包含你的密钥。如果需要密钥,AI 会请你自己粘贴到文件或应用的输入框里。
已经装好了吗?先检查 · 打开终端,输入这条命令后按 Enter
node -vMac:按 ⌘ + Space,输入 Terminal 后按 Enter
Windows:打开“开始”菜单,输入 Windows PowerShell,然后选“打开”
还没安装: 打开官方下载页,选择 LTS 版本和点选式安装程序:Mac 用 .pkg · Windows 用 .msi。双击后一路下一步即可,不需要 curl 命令
装好后关掉终端再打开,重新运行同一条命令,应显示版本号: node -v
安装一次,所有需要 Node.js 的工具都能用
在 SFTP 的设置中,SFTP_PASSWORD, SFTP_PRIVATE_KEY, SFTP_PASSPHRASE 还是空的,填入你的密钥并保存
只把密钥粘贴到应用的输入框里,不要粘贴到聊天中或发给任何人
用 SFTP 告诉我你能帮我做什么,然后做一件给我看✓ 如果 Cursor 说正在使用 SFTP,或回答中出现 SFTP 的工具名称,就表示连接成功
上面的命令不填这些也能用。想调整时再按开发者的说明添加。
SFTP_HOST SSH 主机(单服务器模式)。 SFTP_PORT SSH 端口。 SFTP_USER SSH 用户名(单服务器模式) SFTP_SERVERS_FILE 指向 JSON 映射文件的路径,该映射将服务器 ID 对应到连接信息,用于多服务器配置。会替代单服务器变量。 SFTP_READ_ONLY 拒绝所有远程变更操作。 SFTP_ALLOW_DESTRUCTIVE 设置为 false 以拒绝 delete、rmdir、rename 以及非 dry-run 的 sync。 SFTP_ALLOWED_WRITE_PREFIX 修改操作所限定的绝对远程路径前缀。 SFTP_ALLOWED_READ_PREFIX 读取操作所限定的绝对远程路径前缀。 说明为自动翻译,变量名保持原样;不确定时请查看原文。
菜单名称已于 2026年11月11日 对照 Cursor 帮助页面核实 · 你的界面可能因版本略有不同
可连接 VS Code,但需要先准备
需要 SFTP 的密钥(在开发者网站创建) · 需要先在电脑上安装 Node.js(只需一次)
把这段话复制到 VS Code 的对话里。AI 会先检查电脑,告诉你要改哪个文件,并且每次都等你同意。
请在这台电脑上为 VS Code 安装 MCP server SFTP,按顺序:1) 用 node -v 检查是否有 Node.js。没有的话,请让我从 https://nodejs.org/en/download 安装,不要自己安装。2) 只使用这份配置(已通过 PopNx MCP 检查):{ "servers": { "sftp": { "type": "stdio", "command": "npx", "args": [ "-y", "sftp-mcp" ], "env": { "SFTP_PASSWORD": "your-value", "SFTP_PRIVATE_KEY": "your-value", "SFTP_PASSPHRASE": "your-value" } } } } 3) 告诉我要修改的文件完整路径或要运行的命令,等我同意。4) SFTP_PASSWORD, SFTP_PRIVATE_KEY, SFTP_PASSPHRASE 先保留 "your-value",请我自己把真实值粘贴到文件或应用的输入框里。不要让我在对话里输入密钥。5) 按约定执行,然后确认 SFTP 的工具真的出现了。这段话不包含你的密钥。如果需要密钥,AI 会请你自己粘贴到文件或应用的输入框里。
已经装好了吗?先检查 · 打开终端,输入这条命令后按 Enter
node -vMac:按 ⌘ + Space,输入 Terminal 后按 Enter
Windows:打开“开始”菜单,输入 Windows PowerShell,然后选“打开”
还没安装: 打开官方下载页,选择 LTS 版本和点选式安装程序:Mac 用 .pkg · Windows 用 .msi。双击后一路下一步即可,不需要 curl 命令
装好后关掉终端再打开,重新运行同一条命令,应显示版本号: node -v
安装一次,所有需要 Node.js 的工具都能用
在 SFTP 的设置中,SFTP_PASSWORD, SFTP_PRIVATE_KEY, SFTP_PASSPHRASE 还是空的,填入你的密钥并保存
只把密钥粘贴到应用的输入框里,不要粘贴到聊天中或发给任何人
用 SFTP 告诉我你能帮我做什么,然后做一件给我看✓ 如果 VS Code 说正在使用 SFTP,或回答中出现 SFTP 的工具名称,就表示连接成功
上面的命令不填这些也能用。想调整时再按开发者的说明添加。
SFTP_HOST SSH 主机(单服务器模式)。 SFTP_PORT SSH 端口。 SFTP_USER SSH 用户名(单服务器模式) SFTP_SERVERS_FILE 指向 JSON 映射文件的路径,该映射将服务器 ID 对应到连接信息,用于多服务器配置。会替代单服务器变量。 SFTP_READ_ONLY 拒绝所有远程变更操作。 SFTP_ALLOW_DESTRUCTIVE 设置为 false 以拒绝 delete、rmdir、rename 以及非 dry-run 的 sync。 SFTP_ALLOWED_WRITE_PREFIX 修改操作所限定的绝对远程路径前缀。 SFTP_ALLOWED_READ_PREFIX 读取操作所限定的绝对远程路径前缀。 说明为自动翻译,变量名保持原样;不确定时请查看原文。
菜单名称已于 2026年11月11日 对照 VS Code 帮助页面核实 · 你的界面可能因版本略有不同
Claude Code
claude mcp add --scope user sftp --env SFTP_PASSWORD=your-value --env SFTP_PRIVATE_KEY=your-value --env SFTP_PASSPHRASE=your-value -- npx -y sftp-mcpClaude Desktop (claude_desktop_config.json)
{
"mcpServers": {
"sftp": {
"command": "npx",
"args": [
"-y",
"sftp-mcp"
],
"env": {
"SFTP_PASSWORD": "your-value",
"SFTP_PRIVATE_KEY": "your-value",
"SFTP_PASSPHRASE": "your-value"
}
}
}
}Cursor (~/.cursor/mcp.json)
{
"mcpServers": {
"sftp": {
"command": "npx",
"args": [
"-y",
"sftp-mcp"
],
"env": {
"SFTP_PASSWORD": "your-value",
"SFTP_PRIVATE_KEY": "your-value",
"SFTP_PASSPHRASE": "your-value"
}
}
}
}VS Code (mcp.json)
{
"servers": {
"sftp": {
"type": "stdio",
"command": "npx",
"args": [
"-y",
"sftp-mcp"
],
"env": {
"SFTP_PASSWORD": "your-value",
"SFTP_PRIVATE_KEY": "your-value",
"SFTP_PASSPHRASE": "your-value"
}
}
}
}SFTP_HOST envSFTP_PORT envSFTP_USER envSFTP_PASSWORD 机密 必填 envSFTP_PRIVATE_KEY 机密 必填 envSFTP_PASSPHRASE 机密 必填 envSFTP_SERVERS_FILE envSFTP_READ_ONLY envSFTP_ALLOW_DESTRUCTIVE envSFTP_ALLOWED_WRITE_PREFIX envSFTP_ALLOWED_READ_PREFIX env说明为自动翻译,变量名保持原样;不确定时请查看原文。
这些设置是根据作者在注册中心的条目生成的。如果 README 的写法不同,请以 README 为准。
依据这个服务器的连接方式和各应用自己的文档,检查于 2026年11月10日。
在你的电脑上运行,适用于
ClaudeGooseLM StudioMsty StudioCherry StudioCursorVS Code + GitHub CopilotVisual StudioWindsurf (Devin Desktop)ZedKiroClineContinueJetBrains AI AssistantClaude CodeCodex CLIGemini CLIOpenCodenodecodeWarpLibreChatRaycast
它在你的电脑上运行;安装后,工具列表会显示在你的 AI 应用中。
我们检查的是任何人都能看到的信息;我们没有阅读代码。不适用的检查项不计入总数。 · 检查于 2026年11月20日
注册名称已通过 GitHub 账户 AdversTM 验证,该账户拥有此仓库
代码最后更新于8天前
使用 MIT
它在你的电脑上运行,没有互联网端点
在你的电脑上运行,改用本地设置
它在你的电脑上运行;我们只能读取互联网端点的工具列表
OSV.dev 中没有 sftp-mcp@1.1.4 的记录
只检查这个版本的包本身,不包括所有依赖 · 检查于 2026年11月16日
如果你是作者,可把这段代码贴到 README。徽章会链接回本页。
[](https://mcp.popnx.com/en/servers/adverstm-sftp-mcp)提问、分享技巧或报告无法使用。按“有帮助”数量排序。
还没有评价
与注册中心里这个分类中所有活跃的服务器比较。只有当发布者拥有该仓库时,星标数才计入。
它在 3 项适用的基础检查中通过了 3 项。我们没有阅读代码。在添加密钥或令牌之前,请先看看这个服务器要求哪些权限,并使用只具备所需权限的密钥。
你需要填写:SFTP_PASSWORD, SFTP_PRIVATE_KEY, SFTP_PASSPHRASE
它在你的电脑上运行。你的 AI 应用会在需要时启动它,数据不会经过作者的服务器(除非它自己调用在线服务)。
GitHub 仓库最后更新于8天前,最新版本(1.1.4)于8天前进入注册中心。
支持 MCP 的应用,例如 Claude Desktop、Claude Code、Cursor 和 VS Code。你的电脑上还需要有 Node.js。
同一分类中有:Puter MCP, XcodeBuildMCP, Vexa, Atlassian Rovo MCP Server, Anki MCP Server
同一分类、其他作者、命令已通过检查。官方的排在前面,再按星标排序。
如何看卡片:↓ 每周下载量i★ GitHub 星标i三大支柱:评价 · 检查 · 使用情况i更新 = 最新版本发布到注册中心的时间i
Puter MCP enables AI tools to interact with Puter: manage files, websites, workers, and more
XcodeBuildMCP provides tools for Xcode project management, simulator management, and app utilities.
Meeting bot and transcripts for Google Meet, Teams and Zoom. Live or after, speakers labelled.
Connect to Atlassian Jira, Confluence, Loom, and more to search, create, and manage your work.
MCP server for Anki flashcards: adaptive review, notes, media, and deck management via AnkiConnect.
| 本项 SFTP | Puter MCP | XcodeBuildMCP | Vexa | Atlassian Rovo MCP Server | Anki MCP Server | |
|---|---|---|---|---|---|---|
| 运行位置 | 需要安装在电脑上 | 在云端运行,无需安装 | 需要安装在电脑上 | 在云端运行,无需安装 | 在云端运行,无需安装 | 需要安装在电脑上 |
| 需要密钥 | 是 | 否 | 否 | 是 | 否 | 否 |
| 可在 Claude 中按 + 添加 | 否 | 否 | 否 | 否 | 是 | 否 |
| 基础检查 | 3/3 | 4/4 | 3/3 | 2/4 | 4/4 | 3/3 |
| 许可证 | MIT | AGPL-3.0 | MIT | Apache-2.0 | Apache-2.0 | MIT |
| 价格 | 登记中未列出费用 | 登记中未列出费用 | 登记中未列出费用 | 登记中未列出费用 | 登记中未列出费用 | 登记中未列出费用 |
按原文从作者的仓库复制。PopNx MCP 没有审查或背书其内容。HTML、图片和脚本已被移除。链接会离开本站。
SFTP for AI assistants. Files only, no shell.
A Model Context Protocol server that lets Claude and other MCP clients browse, edit, transfer and sync files over plain SFTP. It works on chrooted, SFTP-only and shared-hosting accounts where SSH-based servers can't run, and the assistant never gets a shell.
Install · Configure · Tools · Security · Contribute
Most MCP servers for remote machines are SSH servers that can also move files. They need a shell account and give the assistant command execution. sftp-mcp does the opposite: it only speaks the SFTP protocol.
| sftp-mcp | Typical SSH MCP server | |
|---|---|---|
| Works with SFTP-only and chrooted accounts | Yes | Usually needs a shell |
| Assistant can run arbitrary commands | No | Yes |
| Read-only, no-delete and path limits per server | Built in | Varies |
| Many hosts from one process | Yes | Varies |
| Parallel transfers over one warm connection per host | Yes | Varies |
| Directory sync that uploads only changed files | Yes | Varies |
The only remote command it ever sends is a fixed sha256sum for hashing. If the account has no shell, it hashes over SFTP instead.
Pick sftp-mcp when the assistant should work with files: deploying a site, editing configs, pulling logs or syncing a build. Pick an SSH server when it needs to run commands.
Requires Node.js 24 or newer. Most MCP clients can start the server straight from npm, with nothing to install:
npx -y sftp-mcp
Or install it globally and use the sftp-mcp command:
npm install -g sftp-mcp
Add the server to your MCP client. For Claude Desktop, edit claude_desktop_config.json:
{
"mcpServers": { "sftp": { "command": "npx", "args": ["-y", "sftp-mcp"], "env": { "SFTP_HOST": "sftp.example.com", "SFTP_USER": "deploy", "SFTP_PRIVATE_KEY": "/home/me/.ssh/id_ed25519" } } } }
On Windows, npx may need to go through cmd: "command": "cmd", "args": ["/c", "npx", "-y", "sftp-mcp"].
For Claude Code:
claude mcp add sftp -e SFTP_HOST=sftp.example.com -e SFTP_USER=deploy \
-e SFTP_PRIVATE_KEY=$HOME/.ssh/id_ed25519 -- npx -y sftp-mcp
Restart the client and ask it something like _"list /var/www on the sftp server"_.
All configuration comes from environment variables. Invalid values stop the server at startup with a clear error, so a typo never quietly loosens a policy.
| Variable | Default | Description |
|---|---|---|
SFTP_HOST | required | SSH host |
SFTP_PORT | 22 | SSH port |
SFTP_USER | required | SSH username |
SFTP_PASSWORD | Password authentication | |
SFTP_PRIVATE_KEY | Path to a private key file | |
SFTP_PASSPHRASE | Passphrase for the private key |
The server is registered with the id default.
Describe the servers as a JSON map of id to connection. Pass it inline in SFTP_SERVERS, or as a file path in SFTP_SERVERS_FILE. You can't set both.
{
"prod": { "host": "prod.example.com", "username": "deploy", "privateKey": "/home/me/.ssh/id_ed25519", "allowedWritePrefix": "/var/www", "allowDestructive": false, "description": "Production web" }, "staging": { "host": "staging.example.com", "port": 2222, "username": "ci", "password": "secret" } }
| Field | Description |
|---|---|
host, username (alias user) | Required |
port | Defaults to 22 |
password, privateKey, passphrase | Credentials. privateKey is a local file path |
readOnly, allowDestructive, readyTimeout | Per-server overrides of the global settings below |
allowedReadPrefix, allowedWritePrefix | Path restrictions, see Access control |
description | Shown to the assistant in sftp_list_servers |
Ids must match A-Za-z0-9*. Unknown fields stop startup. The single-server variables can't be combined with a server map.
| Variable | Default | Description |
|---|---|---|
SFTP_READ_ONLY | false | Deny every remote mutation |
SFTP_ALLOW_DESTRUCTIVE | true | false denies delete, rmdir, rename and non-dry-run sync |
SFTP_ALLOWED_WRITE_PREFIX | Absolute path prefix for mutations (single-server mode) | |
SFTP_ALLOWED_READ_PREFIX | Absolute path prefix for reads (single-server mode) | |
SFTP_DISABLED_TOOLS | Comma-separated tool names to hide from the client | |
SFTP_READY_TIMEOUT | 20000 | SSH handshake timeout, in ms |
SFTP_MAX_READ_BYTES | 1048576 | Size limit for sftp_read. Larger files must use sftp_download |
SFTP_MAX_CONCURRENCY | 8 | Default parallelism of the batch tools |
SFTP_TRANSFER_CONCURRENCY | 64 | In-flight requests per file transfer |
SFTP_CHUNK_SIZE | 32768 | Transfer chunk size in bytes (minimum 1024) |
SFTP_LOG_FILE | Also append logs to this file, for clients that hide stderr. Its directory must exist |
Booleans must be exactly true or false.
Policies apply to each server separately and are checked before any SFTP request is sent.
| Policy | Effect |
|---|---|
readOnly: true | Blocks every mutation, including dry-run sync. Overrides everything else. |
allowDestructive: false | Writes, uploads and mkdir still work. Delete, rmdir, rename/move and non-dry-run sync are blocked. |
allowedWritePrefix | Mutations only inside this path. Both ends of a rename are checked. |
allowedReadPrefix | Listing, reading, downloads, stat and hashing only inside this path. |
Prefixes are normalized and compared as POSIX paths: /srv/app allows /srv/app and /srv/app/x, but not /srv/app-old. A prefix of / allows everything.
[!IMPORTANT]
Prefix checks are lexical. A symlink on the server can still point outside the allowed prefix.
For hard isolation, use a chroot, account permissions, or SFTP server configuration.
To hide tools from the assistant entirely, set SFTP_DISABLED_TOOLS, for example sftp_delete,sftp_sync_dir. Hidden tools are never registered, so they never appear in the client's tool list.
Every tool except sftp_list_servers takes a server argument (one of the configured ids).
| Tool | Kind | Description |
|---|---|---|
sftp_list_servers | discovery | Configured servers with their address, policy and description |
sftp_list | read | List a directory (type, size, mtime, name) |
sftp_read | read | Read a text file, up to SFTP_MAX_READ_BYTES |
sftp_stat | read | File metadata |
sftp_exists | read | false, or the entry type: d, - or l |
sftp_sha256 | read | SHA-256 via sha256sum on the server, falling back to SFTP streaming |
sftp_download | read | Download a remote file to a local path |
sftp_download_many | read | Parallel downloads |
sftp_write | write | Create or overwrite a text file from inline content |
sftp_upload | write | Upload a local file (binary-safe, parallel chunks) |
sftp_mkdir | write | Create a directory, optionally recursive |
sftp_write_many | write | Parallel text writes |
sftp_upload_many | write | Parallel uploads |
sftp_sync_dir | write | Upload missing, changed or newer files. Can also delete remote files missing locally. Supports dryRun |
sftp_delete | destructive | Delete a file |
sftp_rmdir | destructive | Remove a directory, optionally recursive |
sftp_rename | destructive | Rename or move |
sftp_delete_many | destructive | Parallel deletes |
Batch tools report each failure individually, so one bad file doesn't abort the batch.
Requires Bun 1.4+ for tooling. The published pa