Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
104 changes: 33 additions & 71 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,34 +18,18 @@ A Model Context Protocol (MCP) server that enables AI models to manage SSH conne

## Installation

### Option 1: Install from PyPI (Recommended)
### Option 1: Use uvx (Recommended)

```bash
# Install with pip
pip install remoteshell-mcp
No installation required. `uvx` will download and run the server automatically:

# Or install with uv
uv pip install remoteshell-mcp
```bash
uvx remoteshell-mcp
```

### Option 2: Install from Source

#### Prerequisites

- Python 3.11 or higher
- [uv](https://github.com/astral-sh/uv) package manager

#### Steps
### Option 2: Install from PyPI

```bash
# Clone the repository
git clone https://github.com/chouzz/remoteShell-mcp.git
cd remoteShell-mcp

# Install dependencies
uv sync

# The server is now ready to use
pip install remoteshell-mcp
```

## Configuration
Expand Down Expand Up @@ -86,48 +70,34 @@ chmod 600 ~/.remoteShell/config.json

### 2. MCP Client Configuration (Recommended for Claude Code/Cursor)

Configure connections directly in your MCP client settings (see below for specific examples).

### 3. Dynamic Creation
Configure connections directly in your MCP client settings. You can pass connections as inline JSON or reference a config file path.

Create connections on-the-fly using the `create_connection` tool during a conversation with your AI assistant.
**Quick Setup for Claude Code:**

## Client Setup

### Claude Code Configuration
```bash
claude mcp add --transport stdio remoteshell -- remoteshell-mcp --connections "[{\"id\":\"server1\",\"host\":\"192.168.1.100\",\"user\":\"admin\",\"auth_type\":\"password\",\"password\":\"your_password\"}]"
```

Add the following to your Claude Code MCP settings file (usually located at `~/Library/Application Support/Claude/claude_desktop_config.json` on macOS):
Or reference a configuration file:

```json
{
"mcpServers": {
"remoteshell": {
"command": "uv",
"args": [
"--directory",
"/absolute/path/to/remoteShell-mcp",
"run",
"remoteshell-mcp"
]
}
}
}
```bash
claude mcp add --transport stdio remoteshell -- remoteshell-mcp --connections "~/.remoteShell/config.json"
```

#### With Pre-configured Connections:
**Example Configurations:**

**Using uvx (no installation required):**

```json
{
"mcpServers": {
"remoteshell": {
"command": "uv",
"type": "stdio",
"command": "uvx",
"args": [
"--directory",
"/absolute/path/to/remoteShell-mcp",
"run",
"remoteshell-mcp",
"--connections",
"[{\"id\":\"server1\",\"host\":\"192.168.1.100\",\"user\":\"admin\",\"auth_type\":\"password\",\"password\":\"secret\"}]"
"[{\"id\":\"server1\",\"host\":\"192.168.1.100\",\"user\":\"admin\",\"auth_type\":\"password\",\"password\":\"your_password\"}]"
]
}
}
Expand All @@ -140,62 +110,54 @@ Or reference a configuration file:
{
"mcpServers": {
"remoteshell": {
"command": "uv",
"type": "stdio",
"command": "uvx",
"args": [
"--directory",
"/absolute/path/to/remoteShell-mcp",
"run",
"remoteshell-mcp",
"--connections",
"/path/to/your/connections.json"
"~/.remoteShell/config.json"
]
}
}
}
```

### Cursor Configuration

Add the following to your Cursor settings (Settings → Features → MCP):
**Using remoteshell-mcp (after pip install):**

```json
{
"mcpServers": {
"remoteshell": {
"command": "uv",
"type": "stdio",
"command": "remoteshell-mcp",
"args": [
"--directory",
"/absolute/path/to/remoteShell-mcp",
"run",
"remoteshell-mcp"
"remoteshell-mcp",
"--connections",
"[{\"id\":\"server1\",\"host\":\"192.168.1.100\",\"user\":\"admin\",\"auth_type\":\"password\",\"password\":\"your_password\"}]"
]
}
}
}
```

#### With Pre-configured Connections:
Or reference a configuration file:

```json
{
"mcpServers": {
"remoteshell": {
"command": "uv",
"type": "stdio",
"command": "remoteshell-mcp",
"args": [
"--directory",
"/absolute/path/to/remoteShell-mcp",
"run",
"remoteshell-mcp",
"--connections",
"/path/to/your/connections.json"
"~/.remoteShell/config.json"
]
}
}
}
```

**Note**: Replace `/absolute/path/to/remoteShell-mcp` with the actual absolute path to this repository on your system.

## Available Tools

### 1. `create_connection`
Expand Down