🖥️ Shell MCP Server

🖥️ Shell MCP Server

site icon
2025.01.03 0
PythonShell命令执行AI应用集成开发效率
Shell MCP Server 是一个为AI应用程序提供安全Shell命令执行能力的服务,基于Model Context Protocol构建。它允许在指定的目录中安全执行命令,支持多种Shell环境,并具备超时控制和跨平台能力。
View on GitHub

Overview

✨ 核心功能

  • 安全执行:命令只能在指定的目录中运行
  • 多Shell支持:支持bash、sh、cmd、powershell等多种Shell
  • 超时控制:自动终止长时间运行的命令
  • 跨平台:支持Unix和Windows系统
  • 安全默认设置:内置目录和Shell验证

🚀 适用场景

  • 文件操作:如列出目录内容、查找文件
  • 项目管理:如Git操作、包管理
  • 系统信息:如资源使用情况、进程监控
  • 文件处理:如搜索文件内容、文件操作
  • Windows特定操作:如列出进程、系统信息

⚙️ 工具列表

  • pip/uv:用于安装Shell MCP Server
  • bash/sh/cmd/powershell:支持的Shell环境

❓ 常见问题解答

  • 如何安装? 使用pip或uv安装Shell MCP Server
  • 如何配置? 通过命令行参数和环境变量配置行为
  • 如何开发? 设置虚拟环境并安装开发依赖

📝 使用教程

使用依赖

确保已安装Python 3.11+和pip或uv。

安装教程

# 使用pip安装
pip install shell-mcp-server

# 使用uv安装(推荐)
uv pip install shell-mcp-server

调试方式

# 创建并激活虚拟环境
uv venv
source .venv/bin/activate

# 安装开发依赖
uv pip install -e ".[test]"

# 运行测试
python -m pytest

# 运行测试并检查覆盖率
python -m pytest --cov=shell_mcp_server

许可证

该项目遵循 MIT 开源许可条款。