Faucet94 Super Win Cli MCP Server

🚀 Super Windows Server

Super Windows Server is an innovative technology designed to enhance your work efficiency and comfort when using the Windows system. This guide will provide detailed instructions on how to install, configure, and manage this server in a Windows environment.

🚀 Quick Start

Super Windows Server is an innovative technology aimed at enhancing work efficiency and comfort when using the Windows system. This guide will walk you through the installation, configuration, and management of this server in a Windows environment.

📦 Installation

1. Download and Extract the Installation Package

First, download the latest version of the Super Windows Server installation package from the official website and extract it to the target directory.

2. Install Dependencies

Ensure that the following software is installed on your system:

• Node.js (Recommended version: LTS)
• Git (for code management and version control)

3. Configure Environment Variables

Set the following paths in the system environment variables:

• NODE_PATH: Points to the Node.js installation directory.
• GIT_HOME: Points to the Git installation directory.

4. Install Super Windows Server

Open the extracted folder and run the following command to install:

npm install

📚 Documentation

Explanation of the Configuration File (config.json)

The core configuration of the Super Windows Server is stored in the config.json file. Here is a detailed explanation of the key configuration items:

security Configuration

• maxCommandLength: Sets the maximum allowed command length (in characters).
• blockedCommands: Specifies a list of commands that are prohibited from execution (case-insensitive).
• blockedArguments: Specifies a list of command arguments that are prohibited from use (case-insensitive).
• allowedPaths: A key configuration item. Specifies the allowed operation paths, with multiple paths separated by commas. If restrictWorkingDirectory is true, all operations must be performed within these paths.
• restrictWorkingDirectory: A boolean value that determines whether to restrict the working directory.
• logCommands: A boolean value that determines whether to log commands and their outputs (up to maxHistorySize records are retained).
• maxHistorySize: Specifies the maximum number of command histories to retain.
• commandTimeout: Sets the timeout period for commands (in seconds). Commands will be forcibly terminated if they exceed this time.

shells Configuration

• enabled: A boolean value that determines whether to enable the shell.
• command: Specifies the path to the shell executable file.
• args: Specifies the default list of arguments to be passed to the shell.
• blockedOperators: Specifies the operators that are prohibited from use in commands (specific to the shell).

ssh Configuration

• enabled: A boolean value that determines whether to enable the SSH remote execution function.
• connections: An object that contains the configuration information for multiple SSH connections, including the hostname, port, username, and key path.

🔧 Technical Details

Service Management (NSSM)

The Super Windows Server supports advanced service management using NSSM. Here are the common operation commands:

• Start the service:

  Start-Service MCPServer
  

• Stop the service:

  Stop-Service MCPServer
  

• Restart the service:

  Restart-Service MCPServer
  

• Check the status:

  Get-Service MCPServer
  

Uninstallation Steps

1. Open PowerShell with administrative privileges.
2. Navigate to the installation directory of the Super Windows Server.
3. Run the uninstallation script:

   .\uninstall-service.ps1
   

Other Notes

• Debugging Mode: If you need to manually run the server for debugging, run the following command in the project root directory:

  npm run dev
  

• Log Files: All operation logs will be recorded in the logs directory, facilitating subsequent analysis and troubleshooting.

By following the above steps, you can successfully complete the installation and configuration of the Super Windows Server and make personalized settings according to your actual needs. If you have any questions or encounter technical issues, please refer to the official documentation or contact the technical support team at any time.