@futuretea/rancher-mcp-server 0.1.2 → 0.2.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 +42 -2
- package/package.json +7 -7
package/README.md
CHANGED
|
@@ -117,7 +117,8 @@ npx @futuretea/rancher-mcp-server@latest --help
|
|
|
117
117
|
|
|
118
118
|
| Option | Description |
|
|
119
119
|
|--------|-------------|
|
|
120
|
-
| `--port` | Starts the MCP server in HTTP mode and listens on the specified port. Use 0 for stdio mode (default for MCP clients) |
|
|
120
|
+
| `--port` | Starts the MCP server in HTTP/SSE mode and listens on the specified port. Use 0 for stdio mode (default for MCP clients) |
|
|
121
|
+
| `--sse-base-url` | SSE public base URL to use when sending the endpoint message (e.g. https://example.com) |
|
|
121
122
|
| `--log-level` | Sets the logging level (values from 0-9) |
|
|
122
123
|
| `--rancher-server-url` | URL of the Rancher server |
|
|
123
124
|
| `--rancher-token` | Bearer token for Rancher API authentication |
|
|
@@ -133,8 +134,12 @@ npx @futuretea/rancher-mcp-server@latest --help
|
|
|
133
134
|
Create a configuration file `config.yaml`:
|
|
134
135
|
|
|
135
136
|
```yaml
|
|
136
|
-
port: 0 # 0 for stdio mode
|
|
137
|
+
port: 0 # 0 for stdio mode, set to a port number (e.g., 8080) for HTTP/SSE mode
|
|
137
138
|
log_level: 0
|
|
139
|
+
|
|
140
|
+
# SSE (Server-Sent Events) configuration (optional, for HTTP/SSE mode)
|
|
141
|
+
# sse_base_url: https://your-domain.com:8080
|
|
142
|
+
|
|
138
143
|
rancher_server_url: https://your-rancher-server.com
|
|
139
144
|
rancher_token: your-bearer-token
|
|
140
145
|
# Or use Access Key/Secret Key:
|
|
@@ -149,6 +154,41 @@ toolsets:
|
|
|
149
154
|
- rancher
|
|
150
155
|
```
|
|
151
156
|
|
|
157
|
+
### HTTP/SSE Mode
|
|
158
|
+
|
|
159
|
+
The Rancher MCP server supports running in HTTP/SSE (Server-Sent Events) mode for network-based access. This is useful when you want to:
|
|
160
|
+
|
|
161
|
+
- Access the server from remote clients
|
|
162
|
+
- Use the server in a containerized environment
|
|
163
|
+
- Enable multiple clients to connect to the same server instance
|
|
164
|
+
|
|
165
|
+
#### Running in HTTP/SSE Mode
|
|
166
|
+
|
|
167
|
+
```shell
|
|
168
|
+
# Start the server on port 8080
|
|
169
|
+
rancher-mcp-server --port 8080 \
|
|
170
|
+
--rancher-server-url https://your-rancher-server.com \
|
|
171
|
+
--rancher-token your-token
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
The server will expose the following endpoints:
|
|
175
|
+
|
|
176
|
+
- **`/healthz`** - Health check endpoint (returns 200 OK)
|
|
177
|
+
- **`/mcp`** - Streamable HTTP endpoint for MCP protocol
|
|
178
|
+
- **`/sse`** - Server-Sent Events endpoint for real-time communication
|
|
179
|
+
- **`/message`** - Message endpoint for SSE clients
|
|
180
|
+
|
|
181
|
+
#### Using SSE Base URL
|
|
182
|
+
|
|
183
|
+
When deploying behind a reverse proxy or load balancer, you can specify a public base URL:
|
|
184
|
+
|
|
185
|
+
```shell
|
|
186
|
+
rancher-mcp-server --port 8080 \
|
|
187
|
+
--sse-base-url https://your-domain.com:8080 \
|
|
188
|
+
--rancher-server-url https://your-rancher-server.com \
|
|
189
|
+
--rancher-token your-token
|
|
190
|
+
```
|
|
191
|
+
|
|
152
192
|
## 🛠️ Tools and Functionalities <a id="tools-and-functionalities"></a>
|
|
153
193
|
|
|
154
194
|
The Rancher MCP server supports enabling or disabling specific groups of tools and functionalities (toolsets) via the `--toolsets` command-line flag or `toolsets` configuration option.
|
package/package.json
CHANGED
|
@@ -1,18 +1,18 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@futuretea/rancher-mcp-server",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.2.0",
|
|
4
4
|
"description": "Model Context Protocol (MCP) server for Rancher multi-cluster management",
|
|
5
5
|
"main": "./bin/index.js",
|
|
6
6
|
"bin": {
|
|
7
7
|
"rancher-mcp-server": "bin/index.js"
|
|
8
8
|
},
|
|
9
9
|
"optionalDependencies": {
|
|
10
|
-
"@futuretea/rancher-mcp-server-darwin-amd64": "0.
|
|
11
|
-
"@futuretea/rancher-mcp-server-darwin-arm64": "0.
|
|
12
|
-
"@futuretea/rancher-mcp-server-linux-amd64": "0.
|
|
13
|
-
"@futuretea/rancher-mcp-server-linux-arm64": "0.
|
|
14
|
-
"@futuretea/rancher-mcp-server-windows-amd64": "0.
|
|
15
|
-
"@futuretea/rancher-mcp-server-windows-arm64": "0.
|
|
10
|
+
"@futuretea/rancher-mcp-server-darwin-amd64": "0.2.0",
|
|
11
|
+
"@futuretea/rancher-mcp-server-darwin-arm64": "0.2.0",
|
|
12
|
+
"@futuretea/rancher-mcp-server-linux-amd64": "0.2.0",
|
|
13
|
+
"@futuretea/rancher-mcp-server-linux-arm64": "0.2.0",
|
|
14
|
+
"@futuretea/rancher-mcp-server-windows-amd64": "0.2.0",
|
|
15
|
+
"@futuretea/rancher-mcp-server-windows-arm64": "0.2.0"
|
|
16
16
|
},
|
|
17
17
|
"repository": {
|
|
18
18
|
"type": "git",
|