---
title: "SSH"
description: "Inspect host uptime, operating-system identity and filesystem capacity using fixed SSH commands. Authenticate with exactly one of a dedicated restricted account’s password or private key; no arbitrary shell, forwarding o"
---

> 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.

# SSH

<p>Inspect host uptime, operating-system identity and filesystem capacity using fixed SSH commands. Authenticate with exactly one of a dedicated restricted account’s password or private key; no arbitrary shell, forwarding or file transfer. Obtain and verify the server SHA-256 host-key fingerprint out of band. Output is capped at 32 KiB; one bounded native invocation, public addresses only, no retries.</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/ssh#command-ssh-uptime">Inspect host uptime</a> — <code>ssh.uptime</code></td>
<td>Read</td>
</tr>
<tr>
<td><a href="https://help.tooluse.net/integrations/ssh#command-ssh-system">Inspect operating system (uname -a)</a> — <code>ssh.system</code></td>
<td>Read</td>
</tr>
<tr>
<td><a href="https://help.tooluse.net/integrations/ssh#command-ssh-disks">Inspect filesystem capacity (df -Pk)</a> — <code>ssh.disks</code></td>
<td>Read</td>
</tr>
</tbody></table>
</div>
</details>
<h2>Connect and use</h2>

<p><a href="https://www.tooluse.net/tools/integrations/ssh">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 SSH, then enter the issued values in the connection form below.</p>
<ol>
<li>Create a dedicated restricted SSH account on your server. Enable only the fixed uptime, uname -a and df -Pk inspection commands needed by that account. In Tooluse.net Tools → SSH → Connect enter its public hostname, port and username, then fill exactly one of SSH password or Private key (PEM/OpenSSH); leave the other blank. For a protected key, also fill Private key passphrase. Install its public key on the server when using key authentication. Obtain the server SHA-256 host-key fingerprint from a trusted administrator or local console and compare it out of band before entering it; do not trust a fingerprint obtained only from the first network connection. Save, allow only the needed commands and call examples using your Tooluse.net API key. No provider API key is needed. Server access is enforced by the dedicated account; no arbitrary shell, forwarding or file transfer is exposed. Public addresses only, at most 32 KiB output, and no automatic retries.</li>
</ol>
<p><a href="https://www.openssh.com/manual.html">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": {}
}'
</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-ssh-uptime">
<summary><span>Inspect host uptime — <code>ssh.<wbr>uptime</code></span></summary>
<p>Run the fixed uptime command through the restricted SSH account and return stdout, stderr and exitCode. Password and private-key authentication both require a trusted host-key fingerprint. Output is limited to 32 KiB; no custom shell command or retries.</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/ssh?command=ssh.uptime">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>

<p>This tool has no input parameters.</p>

<p><strong>Full JSON Schema</strong></p>

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

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

<pre><code class="language-json">{}
</code></pre>

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

</details>
<details id="command-ssh-system">
<summary><span>Inspect operating system (uname -a) — <code>ssh.<wbr>system</code></span></summary>
<p>Run the fixed uname -a command through the restricted SSH account and return operating-system identity. No arbitrary shell arguments, forwarding or retries; output is limited to 32 KiB.</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/ssh?command=ssh.system">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>

<p>This tool has no input parameters.</p>

<p><strong>Full JSON Schema</strong></p>

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

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

<pre><code class="language-json">{}
</code></pre>

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

</details>
<details id="command-ssh-disks">
<summary><span>Inspect filesystem capacity (df -Pk) — <code>ssh.<wbr>disks</code></span></summary>
<p>Run the fixed df -Pk command through the restricted SSH account and return filesystem capacity in POSIX kilobyte units. No arbitrary shell arguments, mount changes or retries; output is limited to 32 KiB.</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/ssh?command=ssh.disks">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>

<p>This tool has no input parameters.</p>

<p><strong>Full JSON Schema</strong></p>

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

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

<pre><code class="language-json">{}
</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://www.openssh.com/manual.html">Official provider documentation</a></p>

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