---
title: "SFTP"
description: "Inspect file attributes, read one UTF-8 text chunk or obtain the first directory packet over SFTP. Password and private-key authentication use one integration and the existing pinned SSH transport. Use a restricted serve"
---

> Documentation Index
> Fetch the complete documentation index at: https://help.tooluse.net/llms.txt
> Use this file to discover all available pages before exploring further.

# SFTP

<p>Inspect file attributes, read one UTF-8 text chunk or obtain the first directory packet over SFTP. Password and private-key authentication use one integration and the existing pinned SSH transport. Use a restricted server account; no arbitrary shell, file writes, automatic directory traversal or whole-file downloads.</p>

<details data-command-index><summary>What you can do (3)</summary>
<h2>What you can do</h2>
<p>Available commands: 3 (3 read, 0 write). Enable only the commands your application needs.</p>
<div class="nb-table-scroll"><table>
<thead>
<tr>
<th>Command</th>
<th>Effect</th>
</tr>
</thead>
<tbody><tr>
<td><a href="https://help.tooluse.net/integrations/sftp#command-sftp-file-stat">Inspect file attributes</a> — <code>sftp.file.stat</code></td>
<td>Read</td>
</tr>
<tr>
<td><a href="https://help.tooluse.net/integrations/sftp#command-sftp-file-read-text">Read a bounded UTF-8 text chunk</a> — <code>sftp.file.read-text</code></td>
<td>Read</td>
</tr>
<tr>
<td><a href="https://help.tooluse.net/integrations/sftp#command-sftp-directory-list">Read the first directory batch</a> — <code>sftp.directory.list</code></td>
<td>Read</td>
</tr>
</tbody></table>
</div>
</details>
<h2>Connect and use</h2>

<p><a href="https://www.tooluse.net/tools/integrations/sftp">Connect and use</a></p>
<p>Open the integration&#39;s connection form to check the available credential source. The source has not been resolved for this documentation export. The instructions below apply when using your own provider account.</p>
<h2>Get your provider credentials</h2>
<p>Follow these steps for SFTP, then enter the issued values in the connection form below.</p>
<ol>
<li>Create a dedicated SFTP account on your server and restrict it to the intended files, preferably with a server-enforced chroot and read-only filesystem permissions. Tooluse.net does not configure the remote server or enforce a separate folder jail. In Tools → SFTP → Connect enter its public hostname, port and username. Fill exactly one of SSH password or Private key (PEM/OpenSSH), leaving the other blank; use Private key passphrase only with a protected key and install the matching public key on the server. Obtain and independently verify the SHA-256 host-key fingerprint from a trusted administrator/local console before saving. No provider API key is needed. Select only the needed reads, save and use your Tooluse.net API key for the examples. File text reads are explicit UTF-8 byte chunks (at most 32 KiB); choose UTF-8 boundaries and use nextOffset for a later call. Directory reads return only the first server packet and are marked partial unless the directory is immediately empty. Each call opens one pinned SSH connection and closes its handles; no automatic traversal, writes, arbitrary shell, background polling or retries.</li>
</ol>
<p><a href="https://man.openbsd.org/sftp">Official credential setup</a></p>
<h2>Where to enter credentials</h2>
<p>In the integration page, sign in, choose your workspace and open Connect. If a <strong>Credentials</strong> choice is shown, select <strong>Use my credentials</strong>. Fill the following connection fields and save. Provider credentials belong in this form, never in an MCP configuration or tool input.</p>
<div class="nb-table-scroll"><table>
<thead>
<tr>
<th>Connection field</th>
<th>Requirement</th>
</tr>
</thead>
<tbody><tr>
<td>Public hostname</td>
<td>Required</td>
</tr>
<tr>
<td>Port</td>
<td>Optional</td>
</tr>
<tr>
<td>Username</td>
<td>Required</td>
</tr>
<tr>
<td>SSH password (leave blank with a private key)</td>
<td>Optional</td>
</tr>
<tr>
<td>Private key (PEM/OpenSSH)</td>
<td>Optional</td>
</tr>
<tr>
<td>Private key passphrase</td>
<td>Optional</td>
</tr>
<tr>
<td>Server host-key fingerprint (SHA256:base64)</td>
<td>Required</td>
</tr>
</tbody></table>
</div><p>Open API keys and create a Tooluse.net key for the enabled commands.</p>
<p>Set TOOLUSE_API_KEY in your client and use the shared MCP configuration.</p>
<p><a href="https://help.tooluse.net/clients">Configure Claude Code, Codex or Cursor once</a></p>

<h2>Permissions and results</h2>

<p>If you have more than one workspace, check the selected workspace in the connection or API-key dialog before saving. Roles, enabled commands, expiry and revocation use Tooluse.net&#39;s existing permissions. Disabling a connection or revoking a key immediately prevents new calls.</p>

<p>Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.</p>

<p>Your connection&#39;s daily allowance and key permissions also apply. Adding a connection does not make a provider request.</p>

<p>Calls return the shared execution receipt and a Claude tool_result. Provider output varies by operation; consult the provider documentation for its response fields. Unconfirmed calls should be checked before retrying.</p>

<h2>Call from your client</h2>

<p>Use the shared MCP configuration. Refresh your client&#39;s tool list after saving the connection or changing key permissions, then call the returned tool name with the example input below.</p>

<p><a href="https://help.tooluse.net/clients">Configure Claude Code, Codex or Cursor once</a></p>

<h2>Discover your enabled tools</h2>

<p>List permitted tools in Claude format. Read every page using page and size (maximum 100) until all results have been received. Use the returned name, not a catalog capability identifier, in the tool_use block.</p>

<pre><code class="language-bash">curl 'https://api.tooluse.net/v1/tools' \
  -H "Authorization: Bearer $TOOLUSE_API_KEY"
</code></pre>

<p>Find this command in the tool list permitted by your key. Replace svc_FROM_YOUR_TOOL_LIST with its returned name. Use a new Idempotency-Key for each new call and retain it when retrying that same call.</p>

<h2>HTTP call</h2>

<pre><code class="language-bash">curl 'https://api.tooluse.net/v1/tool-calls' \
  -H "Authorization: Bearer $TOOLUSE_API_KEY" \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: replace-with-a-new-call-id' \
  --data '{
  "type": "tool_use",
  "id": "toolu_example",
  "name": "svc_FROM_YOUR_TOOL_LIST",
  "input": {
    "path": "/reports/example.txt"
  }
}'
</code></pre>

<p>Send one Claude tool_use block per request. Keep the same Idempotency-Key when retrying the same request; use a new key for a new call. The response includes the shared Tooluse.net receipt and Claude tool_result. Check both HTTP status and the returned tool result before treating a call as successful.</p>

<h2>Commands</h2>

<details id="command-sftp-file-stat">
<summary><span>Inspect file attributes — <code>sftp.<wbr>file.<wbr>stat</code></span></summary>
<p>Read the known path’s size, permissions, modification time and type using SFTP STAT. Optional server attributes are null when unavailable. Server account/chroot permissions govern access; no file contents or writes.</p>

<p>This is a read operation. Provider rate limits and data access rules still apply.</p>

<p><a href="https://www.tooluse.net/tools/integrations/sftp?command=sftp.file.stat">Connect and use</a></p>

<p><strong>Parameters</strong></p>

<p>Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.</p>

<div class="nb-table-scroll"><table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Required in parent</th>
<th>Description</th>
<th>Constraints</th>
</tr>
</thead>
<tbody><tr>
<td><code>path</code></td>
<td>string</td>
<td>Required</td>
<td>Absolute POSIX path within the dedicated server account; no dot/parent segments or backslashes.</td>
<td><code>minLength: 1; maxLength: 4096; pattern: &quot;^/&quot;</code></td>
</tr>
</tbody></table>
</div>
<p><strong>Full JSON Schema</strong></p>

<p><a href="https://api.tooluse.net/v1/integrations/sftp/commands/sftp.file.stat">Full JSON Schema</a></p>

<p><strong>Example input</strong></p>

<pre><code class="language-json">{
  "path": "/reports/example.txt"
}
</code></pre>

<p>At most 1 provider requests per invocation; timeout: 15 seconds.</p>

</details>
<details id="command-sftp-file-read-text">
<summary><span>Read a bounded UTF-8 text chunk — <code>sftp.<wbr>file.<wbr>read-<wbr>text</code></span></summary>
<p>Read at most limitBytes from an explicit byte offset in a known file. Use nextOffset for another explicit call; eof is true only after an empty read. Offsets and chunk ends must be valid UTF-8 boundaries; binary or incomplete UTF-8 chunks fail. No whole-file download or automatic retry.</p>

<p>This is a read operation. Provider rate limits and data access rules still apply.</p>

<p><a href="https://www.tooluse.net/tools/integrations/sftp?command=sftp.file.read-text">Connect and use</a></p>

<p><strong>Parameters</strong></p>

<p>Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.</p>

<div class="nb-table-scroll"><table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Required in parent</th>
<th>Description</th>
<th>Constraints</th>
</tr>
</thead>
<tbody><tr>
<td><code>path</code></td>
<td>string</td>
<td>Required</td>
<td>Absolute POSIX path within the dedicated server account; no dot/parent segments or backslashes.</td>
<td><code>minLength: 1; maxLength: 4096; pattern: &quot;^/&quot;</code></td>
</tr>
<tr>
<td><code>offset</code></td>
<td>integer</td>
<td>Required</td>
<td>Explicit byte offset, starting at zero.</td>
<td><code>minimum: 0; maximum: 9007199254740991</code></td>
</tr>
<tr>
<td><code>limitBytes</code></td>
<td>integer</td>
<td>Required</td>
<td>Maximum bytes for this call; adapter bound is 32 KiB.</td>
<td><code>minimum: 1; maximum: 32768</code></td>
</tr>
</tbody></table>
</div>
<p><strong>Full JSON Schema</strong></p>

<p><a href="https://api.tooluse.net/v1/integrations/sftp/commands/sftp.file.read-text">Full JSON Schema</a></p>

<p><strong>Example input</strong></p>

<pre><code class="language-json">{
  "path": "/reports/example.txt",
  "offset": 0,
  "limitBytes": 1024
}
</code></pre>

<p>At most 1 provider requests per invocation; timeout: 15 seconds.</p>

</details>
<details id="command-sftp-directory-list">
<summary><span>Read the first directory batch — <code>sftp.<wbr>directory.<wbr>list</code></span></summary>
<p>Open a directory and read exactly one SFTP NAME response packet, returning at most limit entries. complete=false means the result is partial, even when fewer than limit entries are returned. Only an immediate EOF confirms an empty complete directory. No traversal, sorting or automatic pagination; handles close after each invocation.</p>

<p>This is a read operation. Provider rate limits and data access rules still apply.</p>

<p><a href="https://www.tooluse.net/tools/integrations/sftp?command=sftp.directory.list">Connect and use</a></p>

<p><strong>Parameters</strong></p>

<p>Requiredness is local to the containing object. A required child is required only when its parent object or array item is provided. Alternative schemas are identified in the Constraints column; the linked full JSON Schema is authoritative.</p>

<div class="nb-table-scroll"><table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Required in parent</th>
<th>Description</th>
<th>Constraints</th>
</tr>
</thead>
<tbody><tr>
<td><code>path</code></td>
<td>string</td>
<td>Required</td>
<td>Absolute POSIX path within the dedicated server account; no dot/parent segments or backslashes.</td>
<td><code>minLength: 1; maxLength: 4096; pattern: &quot;^/&quot;</code></td>
</tr>
<tr>
<td><code>limit</code></td>
<td>integer</td>
<td>Required</td>
<td>Maximum entries returned from the first server packet; adapter bound is 100.</td>
<td><code>minimum: 1; maximum: 100</code></td>
</tr>
</tbody></table>
</div>
<p><strong>Full JSON Schema</strong></p>

<p><a href="https://api.tooluse.net/v1/integrations/sftp/commands/sftp.directory.list">Full JSON Schema</a></p>

<p><strong>Example input</strong></p>

<pre><code class="language-json">{
  "path": "/reports",
  "limit": 20
}
</code></pre>

<p>At most 1 provider requests per invocation; timeout: 15 seconds.</p>

</details>
<h2>Errors</h2>

<p>Check the key&#39;s expiry, revocation, workspace and allowed operations.</p>

<p>Reuse the same idempotency key only for the same request.</p>

<p>The connection or provider limit has been reached. Check the receipt before retrying.</p>

<h2>Test the connection</h2>

<p>Open the integration&#39;s commands below to inspect parameters and examples. Start with a read command for an account or resource you can access. Refresh your client&#39;s tool list, use the returned tool name, and check the execution result and usage. Provider charges and permissions still apply. Never test a write against production data without reviewing it.</p>

<p><a href="https://man.openbsd.org/sftp">Official provider documentation</a></p>

Source: https://help.tooluse.net/integrations/sftp/index.mdx