Super Shell MCP

🚀 Super Shell

Super Shell is a powerful command shell tool designed to enhance the efficiency of developers and system administrators. It supports cross - platform operations (Windows, macOS, and Linux) and offers a wide range of functional modules, including command management, permission control, logging, and remote configuration.

🚀 Quick Start

✨ Features

• Command Management: Super Shell provides robust command control capabilities. It supports black - and - white list strategies to restrict or allow specific commands through whitelist and blacklist configurations. It also has timeout control to prevent long - unresponsive commands from occupying system resources.
• Permission Control: Based on user roles and environment variables, Super Shell offers flexible permission management. It supports multiple authentication methods (such as token authentication and OAuth) and defines fine - grained access control lists (ACL) for resource access.
• Logging System: Super Shell has a built - in comprehensive logging function for easy debugging and server status monitoring. Log files are stored in the default path logs/super - shell - mcp.log, and the log directory is automatically created with a .gitkeep file for tracking. It supports different log levels like INFO, DEBUG, and ERROR.
• Cross - Platform Support: Super Shell supports Windows (using cmd.exe or PowerShell with proper path separator handling in JSON), and macOS/Linux (defaulting to /bin/bash or a user - specified shell).

📦 Installation

1. Install via npm:

   npm install -g super - shell - mcp
   

2. Manual Installation: Unzip the compressed package to the specified directory and ensure that the executable file has the correct permissions.

Configuration

Super Shell can be customized through the configuration file config.json. Here are the common configuration options:

{
  "shellType": "auto", // Automatically detect the shell type, supports "cmd", "bash", and "powershell"
  "timeout": 30000,    // Command execution timeout in milliseconds
  "whitelist": ["ls", "cd", "cp", "rm"], // Allowed command list
  "blacklist": ["sudo", "su"], // Prohibited command list
  "logLevel": "INFO" // Log level: INFO, DEBUG, ERROR
}

💻 Usage Examples

Basic Usage

# Example: Configure Super Shell to use PowerShell on Windows
{
  "shellType": "powershell",
  "workingDirectory": "C:\\Users\\CurrentUser\\Documents"
}

Advanced Usage

# Example: Execute simple file operations
super - shell - mcp.exe -c "ls" // List files in the current directory
super - shell - mcp.exe -c "cd .." // Go up one level in the directory

Troubleshooting

Windows System

⚠️ Important Note

If you encounter path separator errors, use double backslashes (\\) in the JSON configuration.

macOS/Linux System

⚠️ Important Note

If the command is not found, check the environment variable configuration and ensure that the command exists in the system PATH.

📄 License

Super Shell is licensed under the MIT License:

MIT License

Copyright (c) [year] [copyright holder]

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.

In summary, Super Shell is a feature - rich and easily configurable command shell tool suitable for various operating systems and development environments. Its flexible permission control and logging functions can significantly improve work efficiency and simplify system management.