@teamnetwork-nz/sonicwall-api-mcp-server 0.2.0 → 0.3.0
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 +55 -21
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -17,39 +17,43 @@ Supports SonicOS 6.5.x, 7.x, and 8.x with automatic version detection.
|
|
|
17
17
|
|
|
18
18
|
## Quick Start
|
|
19
19
|
|
|
20
|
+
### Prerequisites
|
|
21
|
+
|
|
22
|
+
- A SonicWall NSA appliance running SonicOS 6.5, 7.x, or 8.x
|
|
23
|
+
- SonicOS API enabled: **Device › Settings › Administration › SonicOS API** — toggle **SonicOS API** on, and ensure **RFC-2617 HTTP Basic Access authentication** is also enabled (the MCP server uses Basic auth to obtain a session token, falling back to RFC-7616 Digest if Basic is disabled)
|
|
24
|
+
- For npm install: [Node.js ≥ 18](https://nodejs.org/) and [uv](https://docs.astral.sh/uv/)
|
|
25
|
+
- For Python install: Python ≥ 3.11
|
|
26
|
+
|
|
20
27
|
### Install
|
|
21
28
|
|
|
22
|
-
**Via
|
|
29
|
+
**Via npx (recommended — no Python setup required):**
|
|
23
30
|
|
|
24
31
|
```bash
|
|
25
|
-
# Run directly with npx (requires uv: https://docs.astral.sh/uv/)
|
|
26
32
|
npx @teamnetwork-nz/sonicwall-api-mcp-server
|
|
27
|
-
|
|
28
|
-
# Or install globally
|
|
29
|
-
npm install -g @teamnetwork-nz/sonicwall-api-mcp-server
|
|
30
|
-
sonicwall-mcp
|
|
31
33
|
```
|
|
32
34
|
|
|
35
|
+
> The npm package is a thin launcher that calls `uvx sonicwall-mcp-server` under the hood. Only [uv](https://docs.astral.sh/uv/) needs to be installed — no Python environment setup required.
|
|
36
|
+
|
|
33
37
|
**Via pip / uv (Python):**
|
|
34
38
|
|
|
35
39
|
```bash
|
|
36
40
|
pip install sonicwall-mcp-server
|
|
37
|
-
# or
|
|
41
|
+
# or
|
|
38
42
|
uv pip install sonicwall-mcp-server
|
|
39
43
|
```
|
|
40
44
|
|
|
41
|
-
|
|
45
|
+
### Environment variables
|
|
42
46
|
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
47
|
+
| Variable | Required | Default | Description |
|
|
48
|
+
|----------|----------|---------|-------------|
|
|
49
|
+
| `SONICWALL_HOST` | Yes | — | Appliance IP or hostname |
|
|
50
|
+
| `SONICWALL_USERNAME` | Yes | — | Admin username |
|
|
51
|
+
| `SONICWALL_PASSWORD` | Yes | — | Admin password |
|
|
52
|
+
| `SONICWALL_PORT` | No | `443` | HTTPS management port |
|
|
53
|
+
| `SONICWALL_SSL_VERIFY` | No | `true` | Set `false` for self-signed certificates |
|
|
54
|
+
| `SONICWALL_READ_ONLY` | No | `true` | Set `false` to allow write operations |
|
|
55
|
+
| `SONICWALL_DEVICES_FILE` | No | — | Path to JSON file for multi-device config |
|
|
56
|
+
| `SONICWALL_REQUEST_TIMEOUT` | No | `30.0` | Per-request timeout in seconds |
|
|
53
57
|
|
|
54
58
|
Copy `.env.example` to `.env` for local development.
|
|
55
59
|
|
|
@@ -69,7 +73,8 @@ Add to your MCP config (`claude_desktop_config.json` or `.claude/settings.json`)
|
|
|
69
73
|
"SONICWALL_HOST": "192.168.168.168",
|
|
70
74
|
"SONICWALL_USERNAME": "admin",
|
|
71
75
|
"SONICWALL_PASSWORD": "your_password",
|
|
72
|
-
"SONICWALL_SSL_VERIFY": "false"
|
|
76
|
+
"SONICWALL_SSL_VERIFY": "false",
|
|
77
|
+
"SONICWALL_READ_ONLY": "false"
|
|
73
78
|
}
|
|
74
79
|
}
|
|
75
80
|
}
|
|
@@ -88,7 +93,8 @@ Add to your MCP config (`claude_desktop_config.json` or `.claude/settings.json`)
|
|
|
88
93
|
"SONICWALL_HOST": "192.168.168.168",
|
|
89
94
|
"SONICWALL_USERNAME": "admin",
|
|
90
95
|
"SONICWALL_PASSWORD": "your_password",
|
|
91
|
-
"SONICWALL_SSL_VERIFY": "false"
|
|
96
|
+
"SONICWALL_SSL_VERIFY": "false",
|
|
97
|
+
"SONICWALL_READ_ONLY": "false"
|
|
92
98
|
}
|
|
93
99
|
}
|
|
94
100
|
}
|
|
@@ -106,13 +112,41 @@ Add to your MCP config (`claude_desktop_config.json` or `.claude/settings.json`)
|
|
|
106
112
|
"SONICWALL_HOST": "192.168.168.168",
|
|
107
113
|
"SONICWALL_USERNAME": "admin",
|
|
108
114
|
"SONICWALL_PASSWORD": "your_password",
|
|
109
|
-
"SONICWALL_SSL_VERIFY": "false"
|
|
115
|
+
"SONICWALL_SSL_VERIFY": "false",
|
|
116
|
+
"SONICWALL_READ_ONLY": "false"
|
|
110
117
|
}
|
|
111
118
|
}
|
|
112
119
|
}
|
|
113
120
|
}
|
|
114
121
|
```
|
|
115
122
|
|
|
123
|
+
### Multi-device setup
|
|
124
|
+
|
|
125
|
+
To manage multiple appliances, set `SONICWALL_DEVICES_FILE` to a JSON file:
|
|
126
|
+
|
|
127
|
+
```json
|
|
128
|
+
[
|
|
129
|
+
{
|
|
130
|
+
"name": "site-a",
|
|
131
|
+
"host": "10.0.1.1",
|
|
132
|
+
"username": "admin",
|
|
133
|
+
"password": "secret",
|
|
134
|
+
"ssl_verify": false,
|
|
135
|
+
"read_only": false
|
|
136
|
+
},
|
|
137
|
+
{
|
|
138
|
+
"name": "site-b",
|
|
139
|
+
"host": "10.0.2.1",
|
|
140
|
+
"username": "admin",
|
|
141
|
+
"password": "secret",
|
|
142
|
+
"ssl_verify": false,
|
|
143
|
+
"read_only": true
|
|
144
|
+
}
|
|
145
|
+
]
|
|
146
|
+
```
|
|
147
|
+
|
|
148
|
+
Pass `device="site-b"` to any tool to target a specific appliance; omit it to use the first device.
|
|
149
|
+
|
|
116
150
|
### Development
|
|
117
151
|
|
|
118
152
|
```bash
|