金大哥 - super-shell-mcp MCP 详情

article

README

🚀 超级壳（Super Shell）

超级壳（Super Shell）是一款强大的命令外壳工具，专为开发人员和系统管理员打造，能有效提升工作效率。它支持 Windows、macOS 和 Linux 等跨平台操作，具备命令管理、权限控制、日志记录和远程配置等丰富功能模块。

🚀 快速开始

超级壳是功能强大的命令外壳工具，支持跨平台操作，提供丰富功能模块，可通过配置文件进行个性化设置。

✨ 主要特性

命令管理：提供强大的命令控制功能，支持黑白名单策略和超时控制，限制或允许特定命令执行，防止长时间未响应命令占用系统资源。
权限控制：基于用户角色和环境变量提供灵活的权限管理，支持多种身份验证方式，可定义细粒度的资源访问权限。
日志系统：内置完善的日志记录功能，便于调试和监控服务器状态，可设置不同日志级别，自动创建日志目录。
跨平台支持：支持 Windows、macOS 和 Linux 操作系统，在不同系统上有相应的命令执行方式。

📦 安装指南

安装

通过 npm 安装：
```
npm install -g super-shell-mcp
```
手动安装：将压缩包解压到指定目录，并确保可执行文件具有正确的权限。

配置

超级壳可以通过配置文件 config.json 进行个性化设置。以下是常用的配置选项：

{
  "shellType": "auto", // 自动检测 shell 类型，支持 "cmd"、"bash" 和 "powershell"
  "timeout": 30000,    // 命令执行超时时间（毫秒）
  "whitelist": ["ls", "cd", "cp", "rm"], // 允许的命令列表
  "blacklist": ["sudo", "su"], // 禁止的命令列表
  "logLevel": "INFO" // 日志级别：INFO、DEBUG、ERROR
}

💻 使用示例

基础用法

配置 Shell

# 示例：配置超级壳使用 PowerShell 在 Windows 上运行
{
  "shellType": "powershell",
  "workingDirectory": "C:\\Users\\CurrentUser\\Documents"
}

执行命令

# 示例：执行简单文件操作
super-shell-mcp.exe -c "ls" // 列出当前目录下的文件
super-shell-mcp.exe -c "cd .." // 返回上一级目录

📚 详细文档

核心功能

命令管理

超级壳提供强大的命令控制功能，支持以下操作：

黑白名单策略：通过 whitelist 和 blacklist 配置，限制或允许特定的命令执行。
超时控制：防止长时间未响应的命令占用系统资源。

权限控制

超级壳基于用户角色和环境变量提供灵活的权限管理：

用户鉴权：
- 支持多种身份验证方式（如令牌认证、OAuth）。
访问控制列表（ACL）：
- 定义细粒度的资源访问权限。

日志系统

超级壳内置了完善的日志记录功能，便于调试和监控服务器状态：

日志文件位置：
- 默认路径：logs/super-shell-mcp.log
- 自动创建日志目录，并包含 .gitkeep 文件以跟踪该目录。
日志级别：
- INFO：记录一般操作信息。
- DEBUG：详细调试信息。
- ERROR：记录错误条件和异常。

跨平台支持

超级壳支持以下操作系统：

Windows：
- 使用 cmd.exe 或 PowerShell 执行命令。
- 注意路径分隔符（反斜杠 \）需要在 JSON 中转义为双反斜杠 (\\)。
macOS/Linux：
- 默认使用 /bin/bash 或用户指定的 shell。

故障排除

Windows 系统

问题：路径分隔符错误。
- 解决方法：在 JSON 配置中，路径分隔符应使用双反斜杠 (\\)。

macOS/Linux 系统

问题：找不到命令。
- 解决方法：检查环境变量配置是否正确，并确保命令存在于系统 PATH 中。

📄 许可证

超级壳遵循 MIT 许可证协议：

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.

super-shell-mcp