Skip to main content
Glama
Faucet94

Super Windows CLI MCP Server

by Faucet94

ssh_execute

Run commands on remote systems securely via SSH, enabling direct management and execution of tasks on connected devices without manual intervention.

Instructions

Execute a command on a remote host via SSH

Example usage:

{
  "connectionId": "raspberry-pi",
  "command": "uname -a"
}

Configuration required in config.json:

{
  "ssh": {
    "enabled": true,
    "connections": {
      "raspberry-pi": {
        "host": "raspberrypi.local",
        "port": 22,
        "username": "pi",
        "password": "raspberry"
      }
    }
  }
}

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
commandYesCommand to execute
connectionIdYesID of the SSH connection to use

Implementation Reference

  • Main MCP tool handler for 'ssh_execute': validates input, retrieves SSH connection from pool, executes command, logs to history, returns output and metadata.
    case "ssh_execute": {
      if (!this.config.ssh.enabled) {
        throw new McpError(
          ErrorCode.InvalidRequest,
          "SSH support is disabled in configuration"
        );
      }
    
      const args = z.object({
        connectionId: z.string(),
        command: z.string()
      }).parse(request.params.arguments);
    
      const connectionConfig = this.config.ssh.connections[args.connectionId];
      if (!connectionConfig) {
        throw new McpError(
          ErrorCode.InvalidRequest,
          `Unknown SSH connection ID: ${args.connectionId}`
        );
      }
    
      try {
        // Validate command
        this.validateCommand('cmd', args.command);
    
        const connection = await this.sshPool.getConnection(args.connectionId, connectionConfig);
        const { output, exitCode } = await connection.executeCommand(args.command);
    
        // Store in history if enabled
        if (this.config.security.logCommands) {
          this.commandHistory.push({
            command: args.command,
            output,
            timestamp: new Date().toISOString(),
            exitCode,
            connectionId: args.connectionId
          });
    
          if (this.commandHistory.length > this.config.security.maxHistorySize) {
            this.commandHistory = this.commandHistory.slice(-this.config.security.maxHistorySize);
          }
        }
    
        return {
          content: [{
            type: "text",
            text: output || 'Command completed successfully (no output)'
          }],
          isError: exitCode !== 0,
          metadata: {
            exitCode,
            connectionId: args.connectionId
          }
        };
      } catch (error) {
        const errorMessage = error instanceof Error ? error.message : String(error);
        if (this.config.security.logCommands) {
          this.commandHistory.push({
            command: args.command,
            output: `SSH error: ${errorMessage}`,
            timestamp: new Date().toISOString(),
            exitCode: -1,
            connectionId: args.connectionId
          });
        }
        throw new McpError(
          ErrorCode.InternalError,
          `SSH error: ${errorMessage}`
        );
      }
    }
  • Tool schema definition including name, description, and input schema for 'ssh_execute' in the ListTools response.
            {
              name: "ssh_execute",
              description: `Execute a command on a remote host via SSH
    
    Example usage:
    \`\`\`json
    {
      "connectionId": "raspberry-pi",
      "command": "uname -a"
    }
    \`\`\`
    
    Configuration required in config.json:
    \`\`\`json
    {
      "ssh": {
        "enabled": true,
        "connections": {
          "raspberry-pi": {
            "host": "raspberrypi.local",
            "port": 22,
            "username": "pi",
            "password": "raspberry"
          }
        }
      }
    }
    \`\`\``,
              inputSchema: {
                type: "object",
                properties: {
                  connectionId: {
                    type: "string",
                    description: "ID of the SSH connection to use",
                    enum: Object.keys(this.config.ssh.connections)
                  },
                  command: {
                    type: "string",
                    description: "Command to execute"
                  }
                },
                required: ["connectionId", "command"]
              }
            },
  • Core implementation of SSH command execution using ssh2 Client.exec, capturing stdout/stderr and exit code.
    async executeCommand(command: string): Promise<{ output: string; exitCode: number }> {
      this.lastActivity = Date.now();
    
      // Check connection and attempt reconnect if needed
      if (!this.isConnected) {
        await this.connect();
      }
    
      return new Promise((resolve, reject) => {
        this.client.exec(command, (err, stream) => {
          if (err) {
            reject(err);
            return;
          }
    
          let output = '';
          let errorOutput = '';
    
          stream
            .on('data', (data: Buffer) => {
              output += data.toString();
            })
            .stderr.on('data', (data: Buffer) => {
              errorOutput += data.toString();
            });
    
          stream.on('close', (code: number) => {
            this.lastActivity = Date.now();
            resolve({
              output: output || errorOutput,
              exitCode: code || 0
            });
          });
        });
      });
    }
  • SSHConnectionPool class that manages persistent SSH connections, providing getConnection for reuse and reconnection logic.
    export class SSHConnectionPool {
      private connections: Map<string, SSHConnection> = new Map();
    
      async getConnection(connectionId: string, config: SSHConnectionConfig): Promise<SSHConnection> {
        let connection = this.connections.get(connectionId);
        
        if (!connection) {
          connection = new SSHConnection(config);
          this.connections.set(connectionId, connection);
          await connection.connect();
        } else if (!connection.isActive()) {
          await connection.connect();
        }
    
        return connection;
      }
    
      async closeConnection(connectionId: string): Promise<void> {
        const connection = this.connections.get(connectionId);
        if (connection) {
          connection.disconnect();
          this.connections.delete(connectionId);
        }
      }
    
      closeAll(): void {
        for (const connection of this.connections.values()) {
          connection.disconnect();
        }
        this.connections.clear();
      }
    }
Behavior3/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

No annotations are provided, so the description carries the full burden. It discloses that SSH configuration is required and provides an example, but lacks details on behavioral traits such as error handling, timeouts, security implications, or output format. The description adds some context (configuration needs) but is incomplete for a mutation tool with no annotation coverage.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is appropriately sized and front-loaded with the core purpose in the first sentence. The example and configuration details are relevant but could be more concise. Overall, it's efficient with minimal waste, though the configuration block is lengthy.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness3/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

Given the tool's complexity (remote execution with configuration dependencies), lack of annotations, and no output schema, the description is partially complete. It covers the basic purpose and configuration but misses critical details like return values, error behavior, and security considerations. It's adequate but has clear gaps for a mutation tool.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, with clear parameter descriptions in the schema. The description adds minimal value beyond the schema by illustrating usage in an example, but does not provide additional semantics like command syntax constraints or connectionId enumeration details. Baseline 3 is appropriate as the schema does the heavy lifting.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose5/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description clearly states the specific action ('Execute a command') and resource ('on a remote host via SSH'), distinguishing it from sibling tools like 'execute_command' (likely local), 'get_command_history' (querying), and 'ssh_disconnect' (connection management). The verb+resource combination is precise and unambiguous.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The description implies usage context through the example and configuration details, suggesting this tool is for remote SSH execution. However, it lacks explicit guidance on when to use this versus alternatives like 'execute_command' (e.g., for local vs. remote commands) or prerequisites beyond configuration. No explicit when-not-to-use or alternative recommendations are provided.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Install Server

Other Tools

Related Tools

Latest Blog Posts

MCP directory API

We provide all the information about MCP servers via our MCP API.

curl -X GET 'https://glama.ai/api/mcp/v1/servers/Faucet94/super-win-cli-mcp-server'

If you have feedback or need assistance with the MCP directory API, please join our Discord server