Win Cli MCP Server

🚀 Windows CLI Server Configuration and API Documentation

This project provides a comprehensive solution for configuring a Windows CLI server and interacting with it through a set of well - defined APIs. It offers robust security features and flexible configuration options.

📚 Documentation

Configuration File Structure

The core configuration of the project is stored in the config.json file, which contains the following key fields:

Core API Functions

Command Execution

• executeCommand

  • Executes a local command.
  • Input:
    • command: The command string to be executed (required).
    • workingDirectory: Optional execution directory, default is the current directory.
  • Output:
    • Returns { success: true, output: String } on success.
    • Returns { success: false, error: String } on failure.

• executeSshCommand

  • Executes a remote SSH command.
  • Input:
    • connectionId: Connection identifier (required).
    • command: The command string to be executed (required).
  • Output:
    • Returns { success: true, output: String } on success.
    • Returns { success: false, error: String } on failure.

Connection Management

• addSshConnection

  • Adds a new SSH connection.
  • Input:
    • connectionId: Connection identifier (required).
    • host: Target host address (required).
    • port: Connection port, default is 22.
    • username: Username (required).
    • password: Password or private key path (optional, key - based authentication is recommended).
  • Output:
    • Returns { success: true } on success.
    • Returns { success: false, error: String } on failure.

• removeSshConnection

  • Deletes a specified SSH connection.
  • Input:
    • connectionId: Connection identifier (required).
  • Output:
    • Returns { success: true } on success.
    • Returns { success: false, error: String } on failure.

Resource URI Definitions

All resources are accessed through RESTful API interfaces with a unified path of /api/v1/:

• /commands Manages local command execution. Supports POST requests to submit new commands.

• /ssh_connections Manages SSH connection configurations. Supports GET (get all connections), POST (add a new connection), and DELETE (delete a specified connection) operations.

Security Precautions

Built - in Protection Mechanisms

1. Command Injection Protection: By default, a multi - layer filtering mechanism is enabled to prevent malicious code injection attacks.
2. Directory Restriction: All command executions are restricted to a preset secure directory to prevent out - of - bounds access.
3. Timeout Control: Long - running unresponsive tasks will be automatically terminated to avoid excessive resource consumption.

Security Warnings

⚠️ Important Note

• Do not directly use user input as command parameters in an untrusted environment.
• Regularly update SSH connection credentials to avoid the risk of password leakage.
• It is recommended to enable additional authentication measures (such as two - factor authentication) to enhance security.

📄 License

This project is licensed under the MIT License:

MIT License

Copyright (c) [Year] [Author's Name]

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.