auth-ssh-mcp 2.0.0 → 2.0.1
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 +19 -7
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,6 +1,14 @@
|
|
|
1
1
|
# auth-ssh-mcp
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[中文文档](README_CN.md)
|
|
4
|
+
|
|
5
|
+
MCP (Model Context Protocol) Server for SSH credential management. Connects to [AuthSSH](https://www.authssh.com) backend service.
|
|
6
|
+
|
|
7
|
+
## Quick Start
|
|
8
|
+
|
|
9
|
+
1. Visit [www.authssh.com](https://www.authssh.com) to register an account
|
|
10
|
+
2. Get your API Key from the dashboard
|
|
11
|
+
3. Configure the MCP server (see [Configuration](#configuration) below)
|
|
4
12
|
|
|
5
13
|
## Features
|
|
6
14
|
|
|
@@ -23,8 +31,10 @@ npx auth-ssh-mcp
|
|
|
23
31
|
|
|
24
32
|
| Variable | Required | Description |
|
|
25
33
|
|----------|----------|-------------|
|
|
26
|
-
| `MCP_SERVER_URL` | Yes |
|
|
27
|
-
| `MCP_API_KEY` | Yes | API Key (starts with `sk_`) |
|
|
34
|
+
| `MCP_SERVER_URL` | Yes | AuthSSH backend service URL (default: `https://www.authssh.com`, or your self-hosted instance) |
|
|
35
|
+
| `MCP_API_KEY` | Yes | API Key (starts with `sk_`), get it from your AuthSSH service dashboard |
|
|
36
|
+
|
|
37
|
+
> **Note**: You can use the official service at [www.authssh.com](https://www.authssh.com) or deploy your own AuthSSH backend instance.
|
|
28
38
|
|
|
29
39
|
### Claude Desktop Configuration
|
|
30
40
|
|
|
@@ -37,7 +47,7 @@ Add to your `claude_desktop_config.json`:
|
|
|
37
47
|
"command": "npx",
|
|
38
48
|
"args": ["auth-ssh-mcp"],
|
|
39
49
|
"env": {
|
|
40
|
-
"MCP_SERVER_URL": "https://
|
|
50
|
+
"MCP_SERVER_URL": "https://www.authssh.com",
|
|
41
51
|
"MCP_API_KEY": "sk_your_api_key_here"
|
|
42
52
|
}
|
|
43
53
|
}
|
|
@@ -45,6 +55,8 @@ Add to your `claude_desktop_config.json`:
|
|
|
45
55
|
}
|
|
46
56
|
```
|
|
47
57
|
|
|
58
|
+
> Replace `MCP_SERVER_URL` with your self-hosted instance URL if not using the official service.
|
|
59
|
+
|
|
48
60
|
### Claude Code Configuration
|
|
49
61
|
|
|
50
62
|
Add to your Claude Code MCP settings:
|
|
@@ -56,7 +68,7 @@ Add to your Claude Code MCP settings:
|
|
|
56
68
|
"command": "npx",
|
|
57
69
|
"args": ["auth-ssh-mcp"],
|
|
58
70
|
"env": {
|
|
59
|
-
"MCP_SERVER_URL": "https://
|
|
71
|
+
"MCP_SERVER_URL": "https://www.authssh.com",
|
|
60
72
|
"MCP_API_KEY": "sk_your_api_key_here"
|
|
61
73
|
}
|
|
62
74
|
}
|
|
@@ -146,8 +158,8 @@ pnpm typecheck
|
|
|
146
158
|
│ HTTP
|
|
147
159
|
▼
|
|
148
160
|
┌─────────────────┐
|
|
149
|
-
│
|
|
150
|
-
│
|
|
161
|
+
│ AuthSSH │
|
|
162
|
+
│ Backend │
|
|
151
163
|
└────────┬────────┘
|
|
152
164
|
│
|
|
153
165
|
│ SSH/SFTP
|