Shell MCP Server

🚀 🖥️ Shell MCP 服務器

Shell MCP 服務器專為模型上下文協議構建，能夠為您的 AI 應用程序添加安全的 Shell 命令執行功能，讓您的應用在不同系統上安全、穩定地運行。

🚀 快速開始

安裝

# 使用 pip
pip install shell-mcp-server

# 使用 uv（推薦）
uv pip install shell-mcp-server

🔌 Claude 桌面集成

將此內容添加到您的 Claude 桌面配置中以啟用 Shell 命令執行：

{
    "mcp": {
        "servers": [
            {
                "name": "shell_mcp",
                "class_name": "ShellMCPClient",
                "args": {}
            }
        ]
    }
}

echo '[mcp]\n  servers = [{{name=\"shell_mcp\", class_name=\"ShellMCPClient\", args={}}}]' >> claudia.toml

✨ 主要特性

• 🔒 安全執行 - 命令僅在指定目錄中運行
• 🐚 多殼支持 - 支持 bash、sh、cmd、powershell
• ⏱️ 超時控制 - 自動終止長時間運行的命令
• 🌍 跨平臺 - 在 Unix 和 Windows 系統上均適用
• 🛡️ 默認安全 - 內置目錄和殼程序驗證

💻 使用示例

基礎用法

在您的代碼中導入並使用 ShellMCPClient：

from shell_mcp_server import ShellMCPClient

# 創建一個 ShellMCP 客戶端實例
client = ShellMCPClient()

# 執行命令
response = client.execute("echo Hello, World!")
print(response)  # 輸出: "Hello, World!\n"

# 設置超時時間（可選）
client.timeout = 10  # 設置為 10 秒

# 帶有參數的命令
response = client.execute("ls -l", working_dir="/path/to/dir")
print(response)

高級用法

您可以自定義以下設置：

• timeout: 指定超時時間（默認：無限制）
• shell_path: 自定義 Shell 解釋器路徑（默認：/bin/sh）
• env: 自定義環境變量
• working_dir: 設置工作目錄

🛠️ 開發

設置您的開發環境：

# 創建並激活虛擬環境
uv venv
source .venv/bin/activate

# 安裝開發依賴項
uv pip install -e ".[test]"

# 運行測試
python -m pytest

# 帶覆蓋率的測試
python -m pytest --cov=shell_mcp_server

🤝 貢獻

歡迎貢獻！請隨意：

• 🐛 報告錯誤
• 💡 提供建議功能
• 🔧 提交拉取請求
• 📚 改進文檔

📄 許可證

MIT 許可證 - 詳情見 LICENSE