@futuretea/rancher-mcp-server 0.1.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/LICENSE +201 -0
- package/README.md +257 -0
- package/bin/index.js +46 -0
- package/package.json +40 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,257 @@
|
|
|
1
|
+
# Rancher MCP Server
|
|
2
|
+
|
|
3
|
+
[](https://github.com/futuretea/rancher-mcp-server/blob/main/LICENSE)
|
|
4
|
+
[](https://www.npmjs.com/package/@futuretea/rancher-mcp-server)
|
|
5
|
+
[](https://github.com/futuretea/rancher-mcp-server/releases/latest)
|
|
6
|
+
|
|
7
|
+
[✨ Features](#features) | [🚀 Getting Started](#getting-started) | [⚙️ Configuration](#configuration) | [🛠️ Tools](#tools-and-functionalities) | [🧑💻 Development](#development)
|
|
8
|
+
|
|
9
|
+
## ✨ Features <a id="features"></a>
|
|
10
|
+
|
|
11
|
+
A powerful and flexible [Model Context Protocol (MCP)](https://blog.marcnuri.com/model-context-protocol-mcp-introduction) server implementation with support for **Rancher multi-cluster management**.
|
|
12
|
+
|
|
13
|
+
- **✅ Multi-cluster Management**: Access and manage multiple Kubernetes clusters through Rancher API
|
|
14
|
+
- **✅ Core Kubernetes Resources**: Perform operations on Kubernetes resources across multiple clusters
|
|
15
|
+
- **List** clusters, nodes, workloads, and namespaces
|
|
16
|
+
- **Get** kubeconfig for any cluster
|
|
17
|
+
- **✅ Rancher-specific Resources**: Access Rancher-specific resources
|
|
18
|
+
- **List** Rancher projects and users
|
|
19
|
+
- **Check** cluster health status
|
|
20
|
+
- **View** project access permissions
|
|
21
|
+
- **✅ Security Configuration**: Support for read-only mode and disabling destructive operations
|
|
22
|
+
- **✅ Multiple Output Formats**: Support for table, YAML, and JSON output formats
|
|
23
|
+
- **✅ Cross-platform Support**: Available as native binaries for Linux, macOS, and Windows, as well as an npm package
|
|
24
|
+
|
|
25
|
+
Unlike other Kubernetes MCP server implementations, this server is **specifically designed for Rancher multi-cluster environments** and provides seamless access to multiple clusters through a single interface.
|
|
26
|
+
|
|
27
|
+
- **✅ Lightweight**: The server is distributed as a single native binary for Linux, macOS, and Windows
|
|
28
|
+
- **✅ High-Performance / Low-Latency**: Directly interacts with Rancher API server without the overhead of calling external commands
|
|
29
|
+
- **✅ Cross-Platform**: Available as a native binary for Linux, macOS, and Windows, as well as an npm package
|
|
30
|
+
- **✅ Configurable**: Supports [command-line arguments](#configuration) to configure the server behavior
|
|
31
|
+
- **✅ Well tested**: The server has an extensive test suite to ensure its reliability and correctness
|
|
32
|
+
|
|
33
|
+
## 🚀 Getting Started <a id="getting-started"></a>
|
|
34
|
+
|
|
35
|
+
### Requirements
|
|
36
|
+
|
|
37
|
+
- Access to a Rancher server
|
|
38
|
+
- Rancher API credentials (Token or Access Key/Secret Key)
|
|
39
|
+
|
|
40
|
+
### Claude Desktop
|
|
41
|
+
|
|
42
|
+
#### Using npx
|
|
43
|
+
|
|
44
|
+
If you have npm installed, this is the fastest way to get started with `@futuretea/rancher-mcp-server` on Claude Desktop.
|
|
45
|
+
|
|
46
|
+
Open your `claude_desktop_config.json` and add the mcp server to the list of `mcpServers`:
|
|
47
|
+
|
|
48
|
+
```json
|
|
49
|
+
{
|
|
50
|
+
"mcpServers": {
|
|
51
|
+
"rancher": {
|
|
52
|
+
"command": "npx",
|
|
53
|
+
"args": [
|
|
54
|
+
"-y",
|
|
55
|
+
"@futuretea/rancher-mcp-server@latest",
|
|
56
|
+
"--rancher-server-url",
|
|
57
|
+
"https://your-rancher-server.com",
|
|
58
|
+
"--rancher-token",
|
|
59
|
+
"your-token"
|
|
60
|
+
]
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
}
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
### VS Code / VS Code Insiders
|
|
67
|
+
|
|
68
|
+
Install the Rancher MCP server extension in VS Code by running the following command:
|
|
69
|
+
|
|
70
|
+
```shell
|
|
71
|
+
# For VS Code
|
|
72
|
+
code --add-mcp '{"name":"rancher","command":"npx","args":["@futuretea/rancher-mcp-server@latest","--rancher-server-url","https://your-rancher-server.com","--rancher-token","your-token"]}'
|
|
73
|
+
|
|
74
|
+
# For VS Code Insiders
|
|
75
|
+
code-insiders --add-mcp '{"name":"rancher","command":"npx","args":["@futuretea/rancher-mcp-server@latest","--rancher-server-url","https://your-rancher-server.com","--rancher-token","your-token"]}'
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
### Cursor
|
|
79
|
+
|
|
80
|
+
Install the Rancher MCP server extension in Cursor by editing the `mcp.json` file:
|
|
81
|
+
|
|
82
|
+
```json
|
|
83
|
+
{
|
|
84
|
+
"mcpServers": {
|
|
85
|
+
"rancher": {
|
|
86
|
+
"command": "npx",
|
|
87
|
+
"args": [
|
|
88
|
+
"-y",
|
|
89
|
+
"@futuretea/rancher-mcp-server@latest",
|
|
90
|
+
"--rancher-server-url",
|
|
91
|
+
"https://your-rancher-server.com",
|
|
92
|
+
"--rancher-token",
|
|
93
|
+
"your-token"
|
|
94
|
+
]
|
|
95
|
+
}
|
|
96
|
+
}
|
|
97
|
+
}
|
|
98
|
+
```
|
|
99
|
+
|
|
100
|
+
## ⚙️ Configuration <a id="configuration"></a>
|
|
101
|
+
|
|
102
|
+
The Rancher MCP server can be configured using command line (CLI) arguments or a configuration file.
|
|
103
|
+
|
|
104
|
+
You can run the CLI executable either by using `npx` or by downloading the [latest release binary](https://github.com/futuretea/rancher-mcp-server/releases/latest).
|
|
105
|
+
|
|
106
|
+
```shell
|
|
107
|
+
# Run the Rancher MCP server using npx (in case you have npm and node installed)
|
|
108
|
+
npx @futuretea/rancher-mcp-server@latest --help
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
```shell
|
|
112
|
+
# Run the Rancher MCP server using the latest release binary
|
|
113
|
+
./rancher-mcp-server --help
|
|
114
|
+
```
|
|
115
|
+
|
|
116
|
+
### Configuration Options
|
|
117
|
+
|
|
118
|
+
| Option | Description |
|
|
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) |
|
|
121
|
+
| `--log-level` | Sets the logging level (values from 0-9) |
|
|
122
|
+
| `--rancher-server-url` | URL of the Rancher server |
|
|
123
|
+
| `--rancher-token` | Bearer token for Rancher API authentication |
|
|
124
|
+
| `--rancher-access-key` | Access key for Rancher API authentication |
|
|
125
|
+
| `--rancher-secret-key` | Secret key for Rancher API authentication |
|
|
126
|
+
| `--list-output` | Output format for resource list operations (one of: table, yaml, json) (default "table") |
|
|
127
|
+
| `--read-only` | If set, the MCP server will run in read-only mode, meaning it will not allow any write operations on the Rancher cluster |
|
|
128
|
+
| `--disable-destructive` | If set, the MCP server will disable all destructive operations on the Rancher cluster |
|
|
129
|
+
| `--toolsets` | Comma-separated list of toolsets to enable. Check the [🛠️ Tools and Functionalities](#tools-and-functionalities) section for more information |
|
|
130
|
+
|
|
131
|
+
### Configuration File
|
|
132
|
+
|
|
133
|
+
Create a configuration file `config.yaml`:
|
|
134
|
+
|
|
135
|
+
```yaml
|
|
136
|
+
port: 0 # 0 for stdio mode
|
|
137
|
+
log_level: 0
|
|
138
|
+
rancher_server_url: https://your-rancher-server.com
|
|
139
|
+
rancher_token: your-bearer-token
|
|
140
|
+
# Or use Access Key/Secret Key:
|
|
141
|
+
# rancher_access_key: your-access-key
|
|
142
|
+
# rancher_secret_key: your-secret-key
|
|
143
|
+
list_output: table
|
|
144
|
+
read_only: false
|
|
145
|
+
disable_destructive: false
|
|
146
|
+
toolsets:
|
|
147
|
+
- config
|
|
148
|
+
- core
|
|
149
|
+
- rancher
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
## 🛠️ Tools and Functionalities <a id="tools-and-functionalities"></a>
|
|
153
|
+
|
|
154
|
+
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.
|
|
155
|
+
This allows you to control which Rancher functionalities are available to your AI tools.
|
|
156
|
+
Enabling only the toolsets you need can help reduce the context size and improve the LLM's tool selection accuracy.
|
|
157
|
+
|
|
158
|
+
### Available Toolsets
|
|
159
|
+
|
|
160
|
+
The following sets of tools are available (all on by default):
|
|
161
|
+
|
|
162
|
+
| Toolset | Description |
|
|
163
|
+
|---------|-------------|
|
|
164
|
+
| config | Tools for managing cluster configuration (kubeconfig) |
|
|
165
|
+
| core | Core Kubernetes resource management tools (clusters, nodes, workloads, namespaces) |
|
|
166
|
+
| rancher | Rancher-specific tools (projects, users, cluster health, access control) |
|
|
167
|
+
|
|
168
|
+
### Tools
|
|
169
|
+
|
|
170
|
+
<details>
|
|
171
|
+
<summary>config</summary>
|
|
172
|
+
|
|
173
|
+
- **kubeconfig_get** - Get kubeconfig file for a cluster
|
|
174
|
+
- `cluster_id` (`string`) **(required)** - ID of the cluster to get kubeconfig for
|
|
175
|
+
|
|
176
|
+
</details>
|
|
177
|
+
|
|
178
|
+
<details>
|
|
179
|
+
<summary>core</summary>
|
|
180
|
+
|
|
181
|
+
- **cluster_list** - List all available Kubernetes clusters
|
|
182
|
+
- `format` (`string`) - Output format: table, yaml, or json (default: "table")
|
|
183
|
+
|
|
184
|
+
- **node_list** - List all nodes in a cluster
|
|
185
|
+
- `cluster` (`string`) - Cluster ID to list nodes from (optional)
|
|
186
|
+
- `format` (`string`) - Output format: table, yaml, or json (default: "table")
|
|
187
|
+
|
|
188
|
+
- **workload_list** - List workloads (deployments, statefulsets, daemonsets, jobs) and orphan pods in a cluster
|
|
189
|
+
- `cluster` (`string`) **(required)** - Cluster ID
|
|
190
|
+
- `project` (`string`) - Project ID to filter workloads (optional)
|
|
191
|
+
- `namespace` (`string`) - Namespace name to filter workloads (optional)
|
|
192
|
+
- `node` (`string`) - Node name to filter workloads (optional)
|
|
193
|
+
- `format` (`string`) - Output format: table, yaml, or json (default: "table")
|
|
194
|
+
|
|
195
|
+
- **namespace_list** - List namespaces in a cluster
|
|
196
|
+
- `cluster` (`string`) **(required)** - Cluster ID
|
|
197
|
+
- `project` (`string`) - Project ID to filter namespaces (optional)
|
|
198
|
+
- `format` (`string`) - Output format: table, yaml, or json (default: "table")
|
|
199
|
+
|
|
200
|
+
</details>
|
|
201
|
+
|
|
202
|
+
<details>
|
|
203
|
+
<summary>rancher</summary>
|
|
204
|
+
|
|
205
|
+
- **project_list** - List Rancher projects across clusters
|
|
206
|
+
- `cluster` (`string`) - Filter projects by cluster ID (optional)
|
|
207
|
+
- `format` (`string`) - Output format: table, yaml, or json (default: "table")
|
|
208
|
+
|
|
209
|
+
- **user_list** - List all Rancher users
|
|
210
|
+
- `format` (`string`) - Output format: table, yaml, or json (default: "table")
|
|
211
|
+
|
|
212
|
+
- **cluster_health** - Get health status of Rancher clusters
|
|
213
|
+
- `cluster` (`string`) - Specific cluster ID to check health (optional)
|
|
214
|
+
- `format` (`string`) - Output format: table, yaml, or json (default: "table")
|
|
215
|
+
|
|
216
|
+
- **project_access** - List user access permissions for Rancher projects
|
|
217
|
+
- `project` (`string`) - Project ID to check access (optional)
|
|
218
|
+
- `cluster` (`string`) - Cluster ID (optional)
|
|
219
|
+
- `format` (`string`) - Output format: table, yaml, or json (default: "table")
|
|
220
|
+
|
|
221
|
+
</details>
|
|
222
|
+
|
|
223
|
+
## 🧑💻 Development <a id="development"></a>
|
|
224
|
+
|
|
225
|
+
### Running with mcp-inspector
|
|
226
|
+
|
|
227
|
+
Compile the project and run the Rancher MCP server with [mcp-inspector](https://modelcontextprotocol.io/docs/tools/inspector) to inspect the MCP server.
|
|
228
|
+
|
|
229
|
+
```shell
|
|
230
|
+
# Compile the project
|
|
231
|
+
make build
|
|
232
|
+
# Run the Rancher MCP server with mcp-inspector
|
|
233
|
+
npx @modelcontextprotocol/inspector@latest $(pwd)/rancher-mcp-server
|
|
234
|
+
```
|
|
235
|
+
|
|
236
|
+
For more development information, see [DEVELOPMENT.md](DEVELOPMENT.md).
|
|
237
|
+
|
|
238
|
+
## Contributing
|
|
239
|
+
|
|
240
|
+
We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for details on how to submit issues, feature requests, and pull requests.
|
|
241
|
+
|
|
242
|
+
### Development
|
|
243
|
+
|
|
244
|
+
For development setup and guidelines, see [DEVELOPMENT.md](DEVELOPMENT.md).
|
|
245
|
+
|
|
246
|
+
## Support
|
|
247
|
+
|
|
248
|
+
If you encounter issues:
|
|
249
|
+
- Create a [GitHub Issue](https://github.com/futuretea/rancher-mcp-server/issues)
|
|
250
|
+
- Check the [troubleshooting guide](TROUBLESHOOTING.md)
|
|
251
|
+
- Review the [documentation](https://github.com/futuretea/rancher-mcp-server/docs)
|
|
252
|
+
|
|
253
|
+
## Community
|
|
254
|
+
|
|
255
|
+
- **GitHub**: [futuretea/rancher-mcp-server](https://github.com/futuretea/rancher-mcp-server)
|
|
256
|
+
- **Issues**: [GitHub Issues](https://github.com/futuretea/rancher-mcp-server/issues)
|
|
257
|
+
- **Discussions**: [GitHub Discussions](https://github.com/futuretea/rancher-mcp-server/discussions)
|
package/bin/index.js
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
|
|
3
|
+
const childProcess = require('child_process');
|
|
4
|
+
|
|
5
|
+
const BINARY_MAP = {
|
|
6
|
+
darwin_x64: {name: 'rancher-mcp-server-darwin-amd64', suffix: ''},
|
|
7
|
+
darwin_arm64: {name: 'rancher-mcp-server-darwin-arm64', suffix: ''},
|
|
8
|
+
linux_x64: {name: 'rancher-mcp-server-linux-amd64', suffix: ''},
|
|
9
|
+
linux_arm64: {name: 'rancher-mcp-server-linux-arm64', suffix: ''},
|
|
10
|
+
win32_x64: {name: 'rancher-mcp-server-windows-amd64', suffix: '.exe'},
|
|
11
|
+
win32_arm64: {name: 'rancher-mcp-server-windows-arm64', suffix: '.exe'},
|
|
12
|
+
};
|
|
13
|
+
|
|
14
|
+
// Resolving will fail if the optionalDependency was not installed or the platform/arch is not supported
|
|
15
|
+
const resolveBinaryPath = () => {
|
|
16
|
+
try {
|
|
17
|
+
const binary = BINARY_MAP[`${process.platform}_${process.arch}`];
|
|
18
|
+
return require.resolve(`${binary.name}/bin/${binary.name}${binary.suffix}`);
|
|
19
|
+
} catch (e) {
|
|
20
|
+
throw new Error(`Could not resolve binary path for platform/arch: ${process.platform}/${process.arch}`);
|
|
21
|
+
}
|
|
22
|
+
};
|
|
23
|
+
|
|
24
|
+
const child = childProcess.spawn(resolveBinaryPath(), process.argv.slice(2), {
|
|
25
|
+
stdio: 'inherit',
|
|
26
|
+
});
|
|
27
|
+
|
|
28
|
+
const handleSignal = () => (signal) => {
|
|
29
|
+
console.log(`Received ${signal}, terminating child process...`);
|
|
30
|
+
if (child && !child.killed) {
|
|
31
|
+
child.kill(signal);
|
|
32
|
+
}
|
|
33
|
+
};
|
|
34
|
+
|
|
35
|
+
['SIGTERM', 'SIGINT', 'SIGHUP'].forEach((signal) => {
|
|
36
|
+
process.on(signal, handleSignal(signal));
|
|
37
|
+
});
|
|
38
|
+
|
|
39
|
+
child.on('close', (code, signal) => {
|
|
40
|
+
if (signal) {
|
|
41
|
+
console.log(`Child process terminated by signal: ${signal}`);
|
|
42
|
+
process.exit(128 + (signal === 'SIGTERM' ? 15 : signal === 'SIGINT' ? 2 : 1));
|
|
43
|
+
} else {
|
|
44
|
+
process.exit(code || 0);
|
|
45
|
+
}
|
|
46
|
+
});
|
package/package.json
ADDED
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@futuretea/rancher-mcp-server",
|
|
3
|
+
"version": "0.1.1",
|
|
4
|
+
"description": "Model Context Protocol (MCP) server for Rancher multi-cluster management",
|
|
5
|
+
"main": "./bin/index.js",
|
|
6
|
+
"bin": {
|
|
7
|
+
"rancher-mcp-server": "bin/index.js"
|
|
8
|
+
},
|
|
9
|
+
"optionalDependencies": {
|
|
10
|
+
"@futuretea/rancher-mcp-server-darwin-amd64": "0.1.1",
|
|
11
|
+
"@futuretea/rancher-mcp-server-darwin-arm64": "0.1.1",
|
|
12
|
+
"@futuretea/rancher-mcp-server-linux-amd64": "0.1.1",
|
|
13
|
+
"@futuretea/rancher-mcp-server-linux-arm64": "0.1.1",
|
|
14
|
+
"@futuretea/rancher-mcp-server-windows-amd64": "0.1.1",
|
|
15
|
+
"@futuretea/rancher-mcp-server-windows-arm64": "0.1.1"
|
|
16
|
+
},
|
|
17
|
+
"repository": {
|
|
18
|
+
"type": "git",
|
|
19
|
+
"url": "git+https://github.com/futuretea/rancher-mcp-server.git"
|
|
20
|
+
},
|
|
21
|
+
"keywords": [
|
|
22
|
+
"mcp",
|
|
23
|
+
"rancher",
|
|
24
|
+
"kubernetes",
|
|
25
|
+
"multi-cluster",
|
|
26
|
+
"model context protocol",
|
|
27
|
+
"model",
|
|
28
|
+
"context",
|
|
29
|
+
"protocol"
|
|
30
|
+
],
|
|
31
|
+
"author": {
|
|
32
|
+
"name": "futuretea",
|
|
33
|
+
"url": "https://github.com/futuretea"
|
|
34
|
+
},
|
|
35
|
+
"license": "Apache-2.0",
|
|
36
|
+
"bugs": {
|
|
37
|
+
"url": "https://github.com/futuretea/rancher-mcp-server/issues"
|
|
38
|
+
},
|
|
39
|
+
"homepage": "https://github.com/futuretea/rancher-mcp-server#readme"
|
|
40
|
+
}
|