shell-mcp

shell-mcp

site icon
2025.02.21 2
TypeScriptshell 命令执行LLM 集成自动化任务开发效率
shell-mcp 是一个提供安全 shell 命令执行能力的 MCP 服务器实现,专为 LLMs(大型语言模型)设计。它通过白名单机制确保只有授权的命令和参数可以执行,同时提供资源控制、超时控制和输出大小限制等安全特性。
View on GitHub

Overview

基本能力

产品定位

shell-mcp 是一个为 LLMs 提供安全 shell 命令执行能力的 MCP 服务器实现。

核心功能

  • 安全执行:仅允许白名单中的命令和参数执行
  • 资源控制:监控内存和 CPU 使用情况
  • 超时控制:自动终止长时间运行的命令
  • 大小限制:对输出大小进行限制以确保安全
  • MCP 集成:与 Claude 和其他兼容 MCP 的 LLMs 协同工作

适用场景

  • 在 LLMs 中安全执行 shell 命令
  • 自动化任务执行
  • 系统监控和状态检查

工具列表

  • shell_ls, shell_pwd, shell_df 等
  • 执行白名单中的 shell 命令
  • 输入参数:
    • command(字符串,必需):要执行的命令
    • args(数组,可选):命令参数
    • timeout(数字,可选):执行超时时间(毫秒)

常见问题解答

  • 支持的命令和参数详见文档中的白名单列表
  • 需要 Node.js 18+ 和 MCP 兼容的 LLM 服务

使用教程

使用依赖

  • Node.js 18+
  • MCP-compatible LLM service

安装教程

npm install @kevinwatt/shell-mcp

调试方式

# 手动启动服务器
npx @kevinwatt/shell-mcp

# 开发模式
npm run watch

# 运行测试
npm test

# 代码检查
npm run lint

许可证

该项目遵循 MIT 开源许可条款,请参阅 MIT 了解完整条款。