MCP Shell Server

🚀 MCP Shell Server 中文文檔

MCP Shell Server 是一個藉助 Model Context Protocol (MCP) 來執行 shell 命令的服務器。它充當 AI 代理與 shell 命令執行之間的橋樑，讓 AI 代理能夠安全地執行 shell 命令。

🚀 快速開始

MCP Shell Server 允許你通過 MCP 協議執行 shell 命令，支持多種 shell 類型，具備詳細的錯誤處理和日誌記錄功能，並且與 MCP Inspector 兼容。以下是使用該服務器的基本步驟：

npx mcp-shell-server

✨ 主要特性

• 執行 shell 命令（支持單行和多行命令）
• 支持多種 shell（bash、zsh、fish、powershell、cmd 等）
• 詳細的錯誤處理和日誌記錄
• MCP Inspector 兼容

📦 安裝指南

從 npm 安裝（作為用戶）

# 使用 npm
npm install -g @mkusaka/mcp-shell-server

# 使用 yarn
yarn global add @mkusaka/mcp-shell-server

# 使用 pnpm
pnpm add -g @mkusaka/mcp-shell-server

從源代碼安裝（用於開發）

# 克隆倉庫
git clone https://github.com/mkusaka/mcp-shell-server.git
cd mcp-shell-server

# 安裝依賴項
pnpm install

# 構建項目
pnpm build

📚 詳細文檔

MCP 配置

遊標配置

將以下內容添加到你的遊標配置文件（~/.cursor/config.json）中：

{
  "mcpServers": {
    "shell": {
      "command": "npx",
      "args": ["-y", "@mkusaka/mcp-shell-server"]
    }
  }
}

Cline 集成

將以下內容添加到 ~/.config/cursor/cursor.json：

{
  "shell": {
    "serverUrl": "http://localhost:13000"
  }
}

配置選項

npx mcp-shell-server --port=13000 --config=config.json

參數說明：

• --port：指定服務器監聽的端口，默認為 13000。
• --config：指定配置文件路徑。

系統信息查詢

訪問以下接口獲取系統信息：

• http://localhost:13000/system-info
• http://localhost:13000/shell（返回當前使用的 shell 路徑）

💻 使用示例

基礎用法

基本命令執行

{
  "name": "shell_exec",
  "parameters": {
    "command": "echo Hello, World!"
  }
}

高級用法

多行命令（Heredoc）執行

{
  "name": "shell_exec",
  "parameters": {
    "command": "cat << EOF | grep 'example'\nThis is an example text.\nAnother line without the keyword.\nEOF"
  }
}

🔧 技術細節

項目結構

src/
├── index.ts                # 主入口文件
└── shell-server/
    ├── index.ts            # Shell 服務器實現
    └── lib/
        └── logger.ts       # 日誌配置

日誌記錄

日誌輸出到 mcp-shell.log 文件中。

📄 許可證

本項目採用 MIT 許可證。