ssh-mcp 1.2.0 → 1.2.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +57 -1
- package/build/index.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -67,7 +67,7 @@
|
|
|
67
67
|
|
|
68
68
|
## Client Setup
|
|
69
69
|
|
|
70
|
-
You can configure Claude Desktop to use this MCP Server.
|
|
70
|
+
You can configure your IDE or LLM like Cursor, Windsurf, Claude Desktop to use this MCP Server.
|
|
71
71
|
|
|
72
72
|
**Required Parameters:**
|
|
73
73
|
- `host`: Hostname or IP of the Linux or Windows server
|
|
@@ -103,6 +103,62 @@ You can configure Claude Desktop to use this MCP Server.
|
|
|
103
103
|
}
|
|
104
104
|
```
|
|
105
105
|
|
|
106
|
+
### Claude Code
|
|
107
|
+
|
|
108
|
+
You can add this MCP server to Claude Code using the `claude mcp add` command. This is the recommended method for Claude Code.
|
|
109
|
+
|
|
110
|
+
**Basic Installation:**
|
|
111
|
+
|
|
112
|
+
```bash
|
|
113
|
+
claude mcp add --transport stdio ssh-mcp -- npx -y ssh-mcp -- --host=YOUR_HOST --user=YOUR_USER --password=YOUR_PASSWORD
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
**Installation Examples:**
|
|
117
|
+
|
|
118
|
+
**With Password Authentication:**
|
|
119
|
+
```bash
|
|
120
|
+
claude mcp add --transport stdio ssh-mcp -- npx -y ssh-mcp -- --host=192.168.1.100 --port=22 --user=admin --password=your_password
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
**With SSH Key Authentication:**
|
|
124
|
+
```bash
|
|
125
|
+
claude mcp add --transport stdio ssh-mcp -- npx -y ssh-mcp -- --host=example.com --user=root --key=/path/to/private/key
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
**With Custom Timeout and No Character Limit:**
|
|
129
|
+
```bash
|
|
130
|
+
claude mcp add --transport stdio ssh-mcp -- npx -y ssh-mcp -- --host=192.168.1.100 --user=admin --password=your_password --timeout=120000 --maxChars=none
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
**Installation Scopes:**
|
|
134
|
+
|
|
135
|
+
You can specify the scope when adding the server:
|
|
136
|
+
|
|
137
|
+
- **Local scope** (default): For personal use in the current project
|
|
138
|
+
```bash
|
|
139
|
+
claude mcp add --transport stdio ssh-mcp --scope local -- npx -y ssh-mcp -- --host=YOUR_HOST --user=YOUR_USER --password=YOUR_PASSWORD
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
- **Project scope**: Share with your team via `.mcp.json` file
|
|
143
|
+
```bash
|
|
144
|
+
claude mcp add --transport stdio ssh-mcp --scope project -- npx -y ssh-mcp -- --host=YOUR_HOST --user=YOUR_USER --password=YOUR_PASSWORD
|
|
145
|
+
```
|
|
146
|
+
|
|
147
|
+
- **User scope**: Available across all your projects
|
|
148
|
+
```bash
|
|
149
|
+
claude mcp add --transport stdio ssh-mcp --scope user -- npx -y ssh-mcp -- --host=YOUR_HOST --user=YOUR_USER --password=YOUR_PASSWORD
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
**Verify Installation:**
|
|
154
|
+
|
|
155
|
+
After adding the server, restart Claude Code and ask Cascade to execute a command:
|
|
156
|
+
```
|
|
157
|
+
"Can you run 'ls -la' on the remote server?"
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
For more information about MCP in Claude Code, see the [official documentation](https://docs.claude.com/en/docs/claude-code/mcp).
|
|
161
|
+
|
|
106
162
|
## Testing
|
|
107
163
|
|
|
108
164
|
You can use the [MCP Inspector](https://modelcontextprotocol.io/docs/tools/inspector) for visual debugging of this MCP Server.
|
package/build/index.js
CHANGED